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

man pages for llapi_changelog_start() and all other llapi_changelog_*() functions

Details

    • Improvement
    • Resolution: Fixed
    • Minor
    • Lustre 2.16.0
    • Lustre 2.13.0
    • None
    • 9223372036854775807

    Description

      Add proper documentation for the Changelog API:

      • llapi_changelog_start.3 man page
        • CHANGELOG_FLAG_FOLLOW flag
        • CHANGELOG_FLAG_BLOCK flag
        • CHANGELOG_FLAG_JOBID flag
        • CHANGELOG_FLAG_EXTRA_FLAGS flag
      • llapi_changelog_set_xflags.3 man page
        • CHANGELOG_EXTRA_FLAG_UIDGID flag
        • CHANGELOG_EXTRA_FLAG_NID flag
        • CHANGELOG_EXTRA_FLAG_OMODE flag
        • CHANGELOG_EXTRA_FLAG_XATTR flag
      • llapi_changelog_recv.3 man page
      • llapi_changelog_free.3 man page
      • llapi_changelog_in_buf.3 man page
      • llapi_changelog_get_fd.3 man page
      • llapi_changelog_clear.3 man page
      • llapi_changelog_fini.3 man page

      As a follow-on to LU-12553 we need to add man page and test cases for the existing functions and code:

      • add test case for CHANGELOG_FLAG_FOLLOW, preferably using llsom_sync since it also doesn't have a test case?

      Attachments

        Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. LU-5657 adding missing man pages for the Lustre user API

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

          Task - A task that needs to be done. LU-15373 changelog improvements tracking

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

          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

          Improvement - An improvement or enhancement to an existing feature or task. LU-12553 polling mode for changelog driver

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

          Activity

            [LU-12837] man pages for llapi_changelog_start() and all other llapi_changelog_*() functions
            pjones Peter Jones added a comment -

            Landed for 2.16

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

            "Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49209/
            Subject: LU-12837 doc: add lfs-changelog* manpages
            Project: fs/lustre-release
            Branch: master
            Current Patch Set:
            Commit: 82e7ad348c77e5c164aa3e3155c9eb91872369d5

            gerrit Gerrit Updater added a comment - "Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49209/ Subject: LU-12837 doc: add lfs-changelog* manpages Project: fs/lustre-release Branch: master Current Patch Set: Commit: 82e7ad348c77e5c164aa3e3155c9eb91872369d5
            gerrit Gerrit Updater added a comment -

            "Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49084/
            Subject: LU-12837 doc: add llapi_changelog* manpages
            Project: fs/lustre-release
            Branch: master
            Current Patch Set:
            Commit: 3fe6dac42bba8c5519ba356750752c419a2ec182

            gerrit Gerrit Updater added a comment - "Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49084/ Subject: LU-12837 doc: add llapi_changelog* manpages Project: fs/lustre-release Branch: master Current Patch Set: Commit: 3fe6dac42bba8c5519ba356750752c419a2ec182
            gerrit Gerrit Updater added a comment -

            "Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49209
            Subject: LU-12837 doc: add lfs-changelog* manpages
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 9a5d43324168a42fa94ed32ea306106ff8331394

            gerrit Gerrit Updater added a comment - "Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49209 Subject: LU-12837 doc: add lfs-changelog* manpages Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 9a5d43324168a42fa94ed32ea306106ff8331394
            gerrit Gerrit Updater added a comment -

            "Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49084
            Subject: LU-12837 doc: add llapi_changelog* manpages
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 88e8536ed86278081db21210f87e25ec0dcb482e

            gerrit Gerrit Updater added a comment - "Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49084 Subject: LU-12837 doc: add llapi_changelog* manpages Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 88e8536ed86278081db21210f87e25ec0dcb482e
            eaujames Etienne Aujames added a comment - - edited

            adilger, yes I can do this but with low priority.
            I think I will have more time after the maintenances in February .

            eaujames Etienne Aujames added a comment - - edited adilger , yes I can do this but with low priority. I think I will have more time after the maintenances in February .
            adilger Andreas Dilger added a comment -

            eaujames, would you be able to work on this? You are doing a fair amount of work on changelogs/HSM currently, so it shouldn't be too hard to write these pages. You could use llapi_fid_parse.3 as an example to start with.

            adilger Andreas Dilger added a comment - eaujames , would you be able to work on this? You are doing a fair amount of work on changelogs/HSM currently, so it shouldn't be too hard to write these pages. You could use llapi_fid_parse.3 as an example to start with.

            People

              eaujames Etienne Aujames
              adilger Andreas Dilger
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: