[LU-5657] adding missing man pages for the Lustre user API

• Status: Resolved
• Project: Lustre
• Fix Version/s: Lustre 2.8.0
• Type: Bug
• Priority: Minor
• Reporter: Frank Zago (Inactive)
• Assignee: Andreas Dilger
• Resolution: Fixed
• Labels: patch
• Severity: 3

Description

Several (many?) Lustre user APIs do not have a man page.

Issue Links

• is related to: LU-930 Update or improvement to a Lustre man...
• is related to: LU-12847 Document llapi_data_version() command
• is related to: LU-6437 python-docutils/rst2man required even...
• is related to: LU-12837 man pages for llapi_changelog_start()...

Comments

[Frank Zago (Inactive)]

Lustre HSM API:
http://review.whamcloud.com/12040

[Robert Read (Inactive)]

I would love to see us switch to using reStructuredText as the primary source for all our man pages. Would you mind submitting a patch that added Makefile rules to format your man pages from rst to man?

[Frank Zago (Inactive)]

Hi Robert, it's part of the patch:

+.rst.3 .rst.7:
+       -rst2man $? $@
+

It could be a little more formal, and be part of configure too. For instance the presence of rst2man should be tested.

[Robert Read (Inactive)]

Doh, completely missed that obviously, sorry.

Yes a configure test and a BuildRequires for python-docutils would also be good, and then we won't need to include the formatted ones in the tree.

[Gerrit Updater]

Oleg Drokin ([e-mail]) merged in patch http://review.whamcloud.com/12040/
Subject: LU-5657 doc: allow the use of rst2man to build man pages
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: e0db2129bb7c1095f1999293b56eda7e722012a9

[Gerrit Updater]

Oleg Drokin ([e-mail]) merged in patch http://review.whamcloud.com/12061/
Subject: LU-5657 man: manpages for Lustre HSM user API
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: 11e22ba171625ec32a82deb9b41a6e8347fe17ff

[Peter Jones]

Landed for 2.8