Man pages for each binary/script

Asked by Jeffrey Ness on 2011-07-18

Greetings,

I was in the process of submitting a build for approval by Fedora/Redhat and noticed one of the guidelines mentioned having a man package for each binary/script:

    http://fedoraproject.org/wiki/Packaging/Guidelines#Man_pages

I'm wondering if you would consider adding man pages for your two executables (mydumper and myloader):

   $ rpmlint /var/lib/mock/epel-5-x86_64/result/mydumper-*x86_64.rpm
   mydumper.x86_64: I: enchant-dictionary-not-found en_US
   mydumper.x86_64: W: no-manual-page-for-binary mydumper
   mydumper.x86_64: W: no-manual-page-for-binary myloader
   2 packages and 0 specfiles checked; 0 errors, 2 warnings.

Thanks for your time

Question information

Language:
English Edit question
Status:
Solved
For:
MySQL Data Dumper Edit question
Assignee:
No assignee Edit question
Solved by:
Jeffrey Ness
Solved:
2011-07-19
Last query:
2011-07-19
Last reply:
2011-07-19
Andrew Hutchings (linuxjedi) said : #1

Hi Jeffrey,

Sorry for the delay, I've been speaking about mydumper in the MySQL London Meetup yesterday and only just got home.

If you have python-sphinx >= 0.6 installed (preferably 1.0 or higher) then man pages should be automatically generated along with html docs.

Many thanks for trying this, I have been meaning to generate a .spec file for a while but haven't had the time. If you have any further problems please let me know.

Jeffrey Ness (jeffrey-ness) said : #2

Andrew,

Thank you very much for pointing this out, I'm not sure how I missed that.

Jeffrey-