为“cabal install”启用 --hyperlink-source

Question

命令 cabal haddock 有非常有用的 --hyperlink-source 选项。 我希望在使用cabal install构建文档时具有源超链接。

票证 #517 似乎就是这样： http://hackage.haskell.org/ trac/hackage/ticket/517

但是，也许可以通过 ~/.cabal/config 文件设置此标志？

如果没有，如何在不安装 Cabal-1.9 的情况下使用 #517 的补丁进行 cabal-install 构建，而 Cabal-1.9 目前是强制性的（由于 12 月的一个补丁）？

Answer 1

目前，在使用“all in one”cabal install 命令时，您无法获得与 --hyperlink-source 选项等效的选项。您引用的票正是关于这个问题的。

Answer 2

对我来说，这有效：

cabal update
cabal install haddock

编辑配置文件 ~/.cabal/config

启用 Documentation: True （删除行开头的“--”就可以了）

---

Cabal Library：

cd ...someNicePlace...    

cabal unpack Cabal

编辑文件Distribution/Simple/Setup.hs，在其中找到defaultHaddockFlags = ...

我将其中一些从False切换为True：

... 
haddockHoogle       = Flag True,
...
haddockHtml         = Flag True,
...
haddockExecutables  = Flag True,
...
haddockHscolour     = Flag True,
...

具有<唯一重要的一个（如果不想，不必更改其他）。

安装更新的 Cabal 库：

sudo cabal install --global

---

cabal-install（cabal shell 命令）

为了让更新的 Cabal Libary 在 cabal shell 命令中工作，我还重新安装了 cabal-install：

cd ...someNicePlace...    

cabal unpack cabal-install

sudo cabal install --global

---

从那时起，shell 命令 cabal -- version 对我说：

cabal-install version 1.16.0.2 
using version 1.16.0.3 of the Cabal library 

而且，根据需要，任何新的 cabal 安装现在都会安装完整的 haddock html 文档，其中默认带有超链接的源代码。

Answer 3

Ticket #517 是关于通过 cabal 传递 haddock 选项，例如如果您有特殊需求，例如构建 hoogle 数据库或使用不同的 CSS，

大多数用户会对标准 haddock 和超链接源感到满意，这在 Cabal-1.8 中是可能的。票号#517适用于您有更大需求的情况。

只需调用 cabal haddock --hyperlink-source 就可以解决问题。

如果您希望将此设置为默认值，您可以按照您提到的方式编辑 ~/.cabal/config 。