bugCompact Disc Input and Control Library - Bugs: bug #39095, Fix NAME paragraph in man pages

 
 

bug #39095: Fix NAME paragraph in man pages

Submitted by:  None
Submitted on:  Tue 28 May 2013 12:52:26 PM UTC  
 
Category: documentationSeverity: 5 - Average
Item Group: DocumentationStatus: Fixed
Privacy: PublicAssigned to: Eric Shattow <eshattow>
Originator Email: -unavailable-Open/Closed: Closed

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Wed 29 May 2013 03:40:05 AM UTC, comment #1:

Committed in 982fff58750399642b3f979483154dc0182498f4
http://git.savannah.gnu.org/cgit/libcdio.git/commit/?id=982fff58750399642b3f979483154dc0182498f4

Eric Shattow <eshattow>
Project MemberIn charge of this item.
Tue 28 May 2013 12:52:26 PM UTC, original submission:

help2man produces by default a frankly embarrassing NAME paragraph which is really not very useful at all, but is unfortunately the best that we can do given that there is no consistent text in the --help output which could otherwise be used.

Note that as well as being included in the manual page, this text is displayed in the whatis(1) output, and searched/displayed by apropos(1) so it is helpful for it to be something other than the default boiler-plate.

The typical fix is either to provide the text via the --name option, or in a [NAME] section of an include file.

I recently received a bug report for help2man about problems with parsing the output of cd-drive, specifically that the --libtool option was not stripping the "lt-" prefix, which led me to look at your include files.

I've just uploaded help2man-1.42.1 which I believe should fix the "lt-" prefix issue.

Attached is a patch to the .help2man files which moves the program description from SYNOPSIS to NAME, so "whatis cd-info" and "apropos cd-" should work correctly.

The new release described above should make the post-processing with sed to remove "lt-" unnecessary, but obviously it would not hurt to keep it for some time while people upgrade.

--bod (help2man maintainer)

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

Attached Files
file #28196:  libcdio.patch added by None (2KiB - text/x-patch - Patch for .help2man files)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by eshattow (Posted a comment)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 4 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Wed 29 May 2013 03:40:05 AM UTCeshattowAssigned toNone=>eshattow
      Open/ClosedOpen=>Closed
    Wed 29 May 2013 03:40:04 AM UTCeshattowStatusNone=>Fixed
    Tue 28 May 2013 12:52:26 PM UTCNoneAttached File-=>Added libcdio.patch, #28196

    Back to the top


    Powered by Savane 3.1-cleanup1