Opened 8 years ago

Last modified 8 months ago

#3351 new bug

Generated ghc man page missing xrefs

Reported by: kaol Owned by:
Priority: lowest Milestone: 8.0.1
Component: Documentation Version: 6.10.3
Keywords: Cc: rwbarton@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Documentation bug Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

The man page for ghc is generated from xml files. Currently, this ignores xrefs, turning, for example

<entry>enable almost all warnings (details in <xref linkend="options-sanity"/>)</entry>

to

enable almost all warnings (details in )

This leads to stunted sentences as well as missing information.

Change History (17)

comment:1 Changed 8 years ago by igloo

difficulty: Unknown
Milestone: 6.12 branch

There have been discussions about rewriting the docs in something like markdown. That might be the best way to fix this.

comment:2 Changed 8 years ago by igloo

Milestone: 6.12 branch6.12.3

comment:3 Changed 7 years ago by igloo

Milestone: 6.12.36.14.1
Priority: normallow

comment:4 Changed 7 years ago by igloo

Milestone: 7.0.17.0.2

comment:5 Changed 7 years ago by igloo

Milestone: 7.0.27.2.1

comment:6 Changed 6 years ago by igloo

Milestone: 7.2.17.4.1

comment:7 Changed 6 years ago by igloo

Milestone: 7.4.17.6.1
Priority: lowlowest

comment:8 Changed 5 years ago by igloo

Milestone: 7.6.17.6.2

comment:9 Changed 4 years ago by rwbarton

Cc: rwbarton@… added
Type of failure: None/Unknown

comment:10 Changed 3 years ago by thoughtpolice

Milestone: 7.6.27.10.1

Moving to 7.10.1.

comment:11 Changed 3 years ago by thoughtpolice

Milestone: 7.10.17.12.1

Moving to 7.12.1 milestone; if you feel this is an error and should be addressed sooner, please move it back to the 7.10.1 milestone.

comment:12 Changed 3 years ago by thoughtpolice

Moving to 7.12.1 milestone; if you feel this is an error and should be addressed sooner, please move it back to the 7.10.1 milestone.

comment:13 Changed 2 years ago by thoughtpolice

Milestone: 7.12.18.0.1

Milestone renamed

comment:14 Changed 2 years ago by thomie

Type of failure: None/UnknownDocumentation bug

comment:15 Changed 2 years ago by bgamari

Things are slightly better now since we generate the manpage via Sphinx, although there is still room for improvement. You now see something like this,

       -Wall  enable almost all warnings (details in options-sanity)

comment:16 Changed 2 years ago by thomie

Resolution: fixed
Status: newclosed

Good enough, let's close this.

comment:17 Changed 8 months ago by nomeata

Resolution: fixed
Status: closednew

This was just reported again (#13488). It might be low priority, but it certainly is not good enough. Ideally, it would say

details in section “Name of the section” in the user manual,

possibly with a link to some canonical online location.

Note: See TracTickets for help on using tickets.