Uploaded image for project: 'Lustre'
  1. Lustre
  2. LU-5657

adding missing man pages for the Lustre user API

Details

    • Bug
    • Resolution: Fixed
    • Minor
    • Lustre 2.8.0
    • None
    • 3
    • 15855

    Description

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

      Attachments

        Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. LU-12847 Document llapi_data_version() command and lfs-data_version.1 command

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. LU-6437 python-docutils/rst2man required even with --disable-doc

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. LU-12837 man pages for llapi_changelog_start() and all other llapi_changelog_*() functions

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. LU-930 Update or improvement to a Lustre man page, documentation, or messages

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Activity

            [LU-5657] adding missing man pages for the Lustre user API
            pjones Peter Jones added a comment -

            Landed for 2.8

            pjones Peter Jones added a comment - Landed for 2.8
            gerrit Gerrit Updater added a comment -

            Oleg Drokin (oleg.drokin@intel.com) 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

            gerrit Gerrit Updater added a comment - Oleg Drokin (oleg.drokin@intel.com) 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
            gerrit Gerrit Updater added a comment -

            Oleg Drokin (oleg.drokin@intel.com) 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 Gerrit Updater added a comment - Oleg Drokin (oleg.drokin@intel.com) 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
            rread Robert Read added a comment -

            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.

            rread Robert Read added a comment - 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.
            fzago Frank Zago (Inactive) added a comment -

            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.

            fzago Frank Zago (Inactive) added a comment - 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.
            rread Robert Read added a comment -

            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?

            rread Robert Read added a comment - 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?
            fzago Frank Zago (Inactive) added a comment -

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

            fzago Frank Zago (Inactive) added a comment - Lustre HSM API: http://review.whamcloud.com/12040

            People

              adilger Andreas Dilger
              fzago Frank Zago (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: