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 made changes -
            Fix Version/s New: Lustre 2.16.0 [ 15190 ]
            Resolution New: Fixed [ 1 ]
            Status Original: Open [ 1 ] New: Resolved [ 5 ]
            eaujames Etienne Aujames made changes -
            Assignee Original: WC Triage [ wc-triage ] New: Etienne Aujames [ eaujames ]
            adilger Andreas Dilger made changes -
            Description Original: Add proper documentation for the Changelog API:
            - {{llapi_changelog_start.3}} man page
              - {{CHANGELOG_FLAG_FOLLOW}} flag (unfortunately no such document exists today that could just be updated)
            - {{llapi_changelog_set_xflags.3}} man page
            - {{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?
            		New: 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?
            adilger Andreas Dilger made changes -
            Description Original: 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?
            - add man page {{llapi_changelog_in_buf.3}}
            - add man page {{llapi_changelog_start.3}} that includes a description of the new {{CHANGELOG_FLAG_FOLLOW}} flag (unfortunately no such document exists today that could just be updated)
            - *bonus points* if you also add man pages for other {{llapi_changelog_\*}} functions
            		New: Add proper documentation for the Changelog API:
            - {{llapi_changelog_start.3}} man page
              - {{CHANGELOG_FLAG_FOLLOW}} flag (unfortunately no such document exists today that could just be updated)
            - {{llapi_changelog_set_xflags.3}} man page
            - {{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?
            adilger Andreas Dilger made changes -
            Summary Original: Document llapi_changelog_start() and llapi_changelog_in_buf() New: man pages for llapi_changelog_start() and all other llapi_changelog_*() functions
            adilger Andreas Dilger made changes -
            Link New: This issue is related to LU-15373 [ LU-15373 ]
            adilger Andreas Dilger made changes -
            Affects Version/s New: Lustre 2.13.0 [ 14290 ]
            adilger Andreas Dilger made changes -
            Link New: This issue is related to LU-5657 [ LU-5657 ]
            adilger Andreas Dilger made changes -
            Link New: This issue is related to LU-930 [ LU-930 ]
            adilger Andreas Dilger made changes -
            Link New: This issue is related to LU-12553 [ LU-12553 ]
            adilger Andreas Dilger created issue -

            People

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

              Dates

                Created:
                Updated:
                Resolved: