Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GHC add man pages #21434

Closed
wants to merge 3 commits into from
Closed

GHC add man pages #21434

wants to merge 3 commits into from

Conversation

lverns
Copy link
Contributor

@lverns lverns commented Dec 27, 2016

Motivation for this change

Adds man pages for ghc versions 8.0.1 and 8.0.2 to resolve issue #20281. Also makes the section titled "The User's Guide" build in the html documentation. Note that man ghci still finds no man pages, but Fedora 24 behaves the same way so that is an upstream issue.

Things done
  • Tested using sandboxing
    (nix.useSandbox on NixOS,
    or option build-use-sandbox in nix.conf
    on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • Linux
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Fits CONTRIBUTING.md.

Fixes NixOS#20281

"Since GHC 8.0, the User’s Guide is authored in ReStructuredText (or ReST
or RST, for short) a rich but light-weight mark-up language aimed at
producing documentation. The Sphinx tool is used to produce the final
PDF and HTML documentation."
- http://ghc.readthedocs.io/en/8.0.1/editing-guide.html
@mention-bot
Copy link

@lverns, thanks for your PR! By analyzing the history of the files in this pull request, we identified @peti, @obadz and @pikajude to be potential reviewers.

@peti
Copy link
Member

peti commented Dec 27, 2016

I merged ae6c7352aa2881bc56550b2150d979b59053616a, f257c5f4d75eb27c502b16f5d4f4cb856abb23e2, and 9bd7d4a443c398985dc18a63c33989416a8f182b to haskell-updates. I'll merge to master once the test builds at http://hydra.nixos.org/jobset/nixpkgs/haskell-updates are through.

@peti
Copy link
Member

peti commented Dec 28, 2016

This patch doesn't seem to work (for ghc 8.0.1). I just looked at ghc in revision
fd42555d32dad10cea70d09fbccc07ce6477919c of haskell-updates, and there's no man page:

$ nix-build --no-out-link "<nixpkgs>" -A ghc 
/nix/store/92i3gzgmrr8whpmln9i81xdzsbcx4pa5-ghc-8.0.1
$ tree /nix/store/92i3gzgmrr8whpmln9i81xdzsbcx4pa5-ghc-8.0.1/share/
/nix/store/92i3gzgmrr8whpmln9i81xdzsbcx4pa5-ghc-8.0.1/share/
└── bash-completion
    └── completions
        └── ghc

2 directories, 1 file

@peti
Copy link
Member

peti commented Dec 28, 2016

8.0.2 has no man page either:

$ nix-build --no-out-link "<nixpkgs>" -A haskell.compiler.ghc802
/nix/store/b63hrp0sanr0wrddg7kvmvzxsa272lq1-ghc-8.0.1.20161213
$ tree /nix/store/b63hrp0sanr0wrddg7kvmvzxsa272lq1-ghc-8.0.1.20161213/share/
/nix/store/b63hrp0sanr0wrddg7kvmvzxsa272lq1-ghc-8.0.1.20161213/share/
└── bash-completion
    └── completions
        └── ghc

Am I missing something?

@lverns
Copy link
Contributor Author

lverns commented Dec 28, 2016

For reasons that aren't particularly clear to me, the man pages and HTML documentation go into the 'doc' output. If you look at the tail end of the output from your build commands, you should see reference to it. Currently, when one uses nix-env to install a package with multiple outputs, they all get installed. So nix-env -iA ghc would bring the man pages and the binaries into the user's profile.

@peti
Copy link
Member

peti commented Dec 28, 2016

Ah, good point. That explains it.

@peti peti closed this in 5274682 Dec 28, 2016
@lverns lverns deleted the ghc-add-man-pages branch July 23, 2017 18:56
@unode unode mentioned this pull request Nov 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants