7

更新:这个问题现在已经过时了。Hackage 现在使用 Haskell 版本 7.10.2 构建,所以不会出现以下故障。这一变化似乎也破坏了答案中提到的一些脚本。

如何将我的 Haskell 包的文档获取到 Hackage 上?

我了解 Hackage 将构建它们的内容,但出现错误

Resolving dependencies...
cabal: Could not resolve dependencies:
trying: MyPackage-0.1.0.2 (user goal)
next goal: base (dependency of MyPackage-0.1.0.2)
rejecting: base-4.7.0.1/installed-e4b... (conflict: MyPackage => base>=4.8 &&
<4.9)
rejecting: base-4.8.1.0, 4.8.0.0, 4.7.0.2, 4.7.0.1, 4.7.0.0, 4.6.0.1, 4.6.0.0,
4.5.1.0, 4.5.0.0, 4.4.1.0, 4.4.0.0, 4.3.1.0, 4.3.0.0, 4.2.0.2, 4.2.0.1,
4.2.0.0, 4.1.0.0, 4.0.0.0, 3.0.3.2, 3.0.3.1 (global constraint requires
installed instance)
Dependency tree exhaustively searched.

我无法降低我的包的要求(这似乎是自动构建的障碍),我看到一些包说“用户上传的文档”。但是,任何构建尝试都会失败(见下文。)

如何将我的 Haskell 包的文档获取到 Hackage 上?特别是,我需要做什么才能自己上传它们?


试过了

$ cp -R ./dist/doc/html/MyPackage/ MyPackage-0.1.0.2-docs
$ tar cvzf --format=ustar -f MyPackage-0.1.0.2-docs.tar.gz MyPackage-0.1.0.2-docs
$ curl -X PUT -H 'Content-Type: application/x-tar' -H 'Content-Encoding: gzip' --data-binary '@MyPackage-0.1.0.2-docs.tar.gz' 'https://hackage.haskell.org/package/MyPackage-0.1.0.2/docs' -u 'Rax'

但得到

无效的文档 tarball:tar 存档中的文件不在预期的目录“MyPackage-0.1.0.2-docs”中


name:                   MyPackage
version:                0.1.0.2
license:                BSD3
license-file:           LICENSE
-- copyright:           
category:               Development
build-type:             Simple
-- extra-source-files:  
cabal-version:          >= 1.22.1.1

library
    -- default-extensions: Trustworthy
    exposed-modules:    MyMod.A,
                        MyMod.A.B
    other-modules:      MyMod.C
    -- other-extensions:
    build-depends:      base >= 4.8.1.0 && <4.9,
                        containers >= 0.5.5.1,
                        split >= 0.2.2,
                        MissingH >= 1.3.0.1
    -- hs-source-dirs:
    default-language:   Haskell2010

我也尝试了下面链接的几个脚本的我自己的版本,但得到了同样的错误:

#!/bin/bash

cabal haddock --hyperlink-source --html-location='/package/$pkg-$version/docs'  --contents-location='/package/$pkg'
S=$?
if [ "${S}" -eq "0" ]; then
    cd "dist/doc/html"
    DDIR="${1}-${2}-docs"
    cp -r "${1}" "${DDIR}" && tar -c -v -z --format=ustar -f "${DDIR}.tar.gz" "${DDIR}"
    CS=$?
    if [ "${CS}" -eq "0" ]; then
        echo "Uploading to Hackage…"
        curl -X PUT -H 'Content-Type: application/x-tar' -H 'Content-Encoding: gzip' --data-binary "@${DDIR}.tar.gz" --digest --netrc "https://hackage.haskell.org/package/${1}-${2}/docs"
        exit $?
    else
        echo "Error when packaging the documentation"
        exit $CS
    fi
else
    echo "Error when trying to build the package."
    exit $S
fi

我用它调用

myscript MyPackage 0.1.0.2

但得到同样的错误。

4

2 回答 2

5

你的图书馆需要base >= 4.8.1.0吗?

这就是问题所在 - Hackage 正在尝试使用base == 4.7.0.1与您的 cabal 文件冲突的内容。

我想看看您是否可以使用 Hackage 使用的基础构建您的库。

一些将文档上传到 Hackage 的链接:

于 2015-09-24T19:35:06.767 回答
4

即使文档建立在 hackage 的基础上,它们也需要一些时间才能出现,并且在某些时候它们被破坏了很长一段时间。我已经习惯了使用neil这里描述的工具来做到这一点:

http://neilmitchell.blogspot.si/2014/10/fixing-haddock-docs-on-hackage.html

我首先安装 neil(在我磁盘上的另一个沙箱中),然后在您的库的文件夹中:

neil docs --username=YourHackageUsername

它会为您处理所有细节!

于 2015-09-27T14:37:08.470 回答