From 38ee19f1edbebaa9673961c5e55b52157c27ec96 Mon Sep 17 00:00:00 2001 From: gbaz Date: Sun, 23 Oct 2016 20:04:10 -0400 Subject: [PATCH 1/2] Upload page improvements Some cleanup and modernization of the upload page. --- datafiles/templates/upload.html.st | 43 +++++++++++------------------- 1 file changed, 16 insertions(+), 27 deletions(-) diff --git a/datafiles/templates/upload.html.st b/datafiles/templates/upload.html.st index adfe1ffaf..e28668fcf 100644 --- a/datafiles/templates/upload.html.st +++ b/datafiles/templates/upload.html.st @@ -39,12 +39,6 @@ the Maintainer field as above either to commit to supporting the fo yourself or to mark it as unsupported.

-

Note that all of the above is a makeshift upload policy based on the features -available in the newer hackage-server. The Maintainer field has its uses, -as does maintainer user groups. The libraries mailing list should probably -determine the best approach for this. -

-

Upload forms

Some last formalities: to upload a package, you'll need a Hackage username and password. (Alternatively, there's a @@ -72,37 +66,32 @@ See the notes at the bottom of the page.

  • - Categories are determined by whatever you put in the Category field - (there's no agreed list of category names yet). + Categories are determined by whatever you put in the Category field. + You should try to pick existing categories when possible. You can have more than one category, separated by commas. If no other versions of the package exist, the categories automatically become the package's tags.
  • - Documentation for library packages should be generated by a maintainer. - The means of doing this is still up in the air. + Occasional changes to the GHC base package can mean that some work needs to be done to make packages compatible across a range of versions. + See these notes for some tips in how to do so. + + There are some notes for upgrading much older packages as well.
    • -
  • - We have moved to Haddock 2, and expect some glitches. +

    Documentation

    - If you notice anything broken, please report it on the - Haddock bug tracker. -
    • +

    +The hackage-server attempts to build documentation for library packages, but this can fail. Maintainers can generate their own documentation and upload it by using something along the lines of the shell script below (note that the last two commands are the key ones):

    +
    +set -e
 
-  
  • 
-    In GHC 6.8, several modules were split from the base package
-    into other packages.
+dir=$(mktemp -d dist-docs.XXXXXX)
+trap 'rm -r "$dir"' EXIT
 
-    See these notes
-    on making packages work with a range of versions of GHC.
-  
    • 
-
-  
  • 
-    While Haddock 2
-    accepts GHC features, it is also more picky about comment syntax than
-    the old version.
-  
    • 
+cabal haddock --builddir="$dir" --for-hackage --haddock-option=--hyperlinked-source
+cabal upload -d $dir/*-docs.tar.gz
+
    From 3b928ebfb16751cf84e9575bbe12c3cf2f6da179 Mon Sep 17 00:00:00 2001 From: gbaz Date: Sun, 23 Oct 2016 20:09:19 -0400 Subject: [PATCH 2/2] Update upload.html.st --- datafiles/templates/upload.html.st | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/datafiles/templates/upload.html.st b/datafiles/templates/upload.html.st index e28668fcf..dd1fa9771 100644 --- a/datafiles/templates/upload.html.st +++ b/datafiles/templates/upload.html.st @@ -41,7 +41,7 @@ yourself or to mark it as unsupported.

    Upload forms

    Some last formalities: to upload a package, you'll need a Hackage -username and password. (Alternatively, there's a +username and password. (Alternatively, there's a command-line interface via cabal-install, which also needs the same username and password.)