Community Packages

Please read this before reporting a bug:
https://wiki.archlinux.org/title/Bug_reporting_guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#58484 - [ghc] Issues in manual page

Attached to Project: Community Packages
Opened by Dominik Schrempf (dschrempf) - Monday, 07 May 2018, 13:50 GMT
Last edited by Ivy Foster (escondida) - Thursday, 10 October 2019, 18:36 GMT
Task Type Bug Report
Category Packages
Status Closed
Assigned To Felix Yan (felixonmars)
Architecture All
Severity Very Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:
The manual page of `ghc` refers to a PDF and html documentation that is not provided.

Additional info:
* package version(s)
ghc 8.2.2-1

* config and/or log files etc.
None

Steps to reproduce:
- `man ghc`
- `/PDF`

Quote:
This manual page documents briefly the ghc and ghci commands. Note that ghci is not yet available on all architectures. Extensive documentation is available in various other formats including PDF and HTML; see below.

There is not reference to a manual or documentation below.

The documentation to the latest release can be found here:
https://downloads.haskell.org/~ghc/8.4.2-rc1/docs/html/users_guide/index.html
This task depends upon

Closed by  Ivy Foster (escondida)
Thursday, 10 October 2019, 18:36 GMT
Reason for closing:  Upstream
Additional comments about closing:  OP's issue is with upstream's wording; recommended submitting a documentation patch.
Comment by Ivy Foster (escondida) - Thursday, 10 October 2019, 02:40 GMT
dschrempf, the docs seem to be in the ghc-static package. Would you consider adding an optdepends on ghc-static to be a sufficient fix?
Comment by Dominik Schrempf (dschrempf) - Thursday, 10 October 2019, 09:14 GMT
Hi, thanks for your answer! The reason why I posted this, is that the manual page refers to something ("see below"), which is not present in the manual page, and so, misleading. Instead, it should refer to the ghc-static package, which includes those PDFs. However, I don't know if Arch actually can change the man page of ghc, or if the man page is provided from upstream?

EDIT: I filed an upstream issue, see
https://gitlab.haskell.org/ghc/ghc/issues/17342
Comment by Ivy Foster (escondida) - Thursday, 10 October 2019, 18:35 GMT
dschrempf, the manual is from upstream. With that in mind, I'm going to go ahead and close this bug--but if it's important to you, you might consider submitting a clarifying documentation patch to GHC.

Loading...