After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 328172 - Allow multiple man sections (1,1p,etc) to map to a single TOC category in man.xml
Allow multiple man sections (1,1p,etc) to map to a single TOC category in man...
Status: RESOLVED FIXED
Product: yelp
Classification: Applications
Component: Man Pages
2.13.x
Other Linux
: Normal normal
: ---
Assigned To: Brent Smith (smitten)
Yelp maintainers
Depends on:
Blocks:
 
 
Reported: 2006-01-22 15:52 UTC by Brent Smith (smitten)
Modified: 2006-01-29 21:11 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
here she is (1.96 KB, patch)
2006-01-22 15:53 UTC, Brent Smith (smitten)
none Details | Review
changes the man.xml.in file to include more sections (1.30 KB, patch)
2006-01-22 16:11 UTC, Brent Smith (smitten)
none Details | Review
updated patch (4.71 KB, patch)
2006-01-28 06:57 UTC, Brent Smith (smitten)
committed Details | Review

Description Brent Smith (smitten) 2006-01-22 15:52:06 UTC
Attaching a patch to add support for mapping several man sections, such as 1, 1p, etc. to a single TOC section in data/man.xml.in

This gives us several benefits:
  * we can add man sections as we come across them and put them in the most 
    appropriate toc section already available without requiring new translations
  * Once the sections are listed in man.xml.in, the link trail will not be broken 
    for that section anymore (open the GET.1 man page in the current Yelp - you'll 
    notice that the link trail at the top does not work because section 1p is not 
    listed in man.xml.in)

Details:
  The sect attribute of the <toc> element is now a space separated list of manual sections to put under this section in the toc.
Comment 1 Brent Smith (smitten) 2006-01-22 15:53:40 UTC
Created attachment 57855 [details] [review]
here she is

testing/comments welcome
Comment 2 Brent Smith (smitten) 2006-01-22 16:11:17 UTC
Created attachment 57856 [details] [review]
changes the man.xml.in file to include more sections

Apply this in addition to the first patch
Comment 3 Brent Smith (smitten) 2006-01-28 06:57:34 UTC
Created attachment 58254 [details] [review]
updated patch

This is an updated patch - first of all it includes the changes to man.xml.in as well as the code.  Secondly, it enables a g_warning() that prints out an error when it can not find the section to place a man page in.

I would particulary like feedback from people on systems who have a lot of man pages.  RHEL4 and FC4 systems or basically any system with a lot of stuff installed on it.

I have done some research regarding man page sections on different systems, and I think I've added support for pretty much everything...

This patch includes two new sections, POSIX Headers (0p) and POSIX Functions (3p) which will need to be translated if the patch goes in.  Note that this fixes a lot of blank/unpopulated linktrails for man pages.

I'd be interested to hear from people on Solaris/other platforms as well.  I don't even know how the man page stuff fares on these...
Comment 4 Brent Smith (smitten) 2006-01-29 21:11:46 UTC
Committed on HEAD.