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

Add kernel-doc style comments to All lustre Code describing function & parameters.

Details

    • Epic
    • Resolution: Unresolved
    • Minor
    • Upstream
    • None
    • Add kernel-doc style comments to All lustre Code.
    • 9223372036854775807

    Description

      Presently not all of lustre code is covered with structured documentation or kernel-doc style comments describing functions and parameters or types. This EPIC/Story/Bug aims to add these remaining coverage. Once this is done, it can then be used to create a documentation as docbook or more latest sphinx format.

      Sample Kernel-doc functional documentation format:
      /**
       * foobar() - Brief description of foobar.
       * @arg: Description of argument of foobar.
       *
       * Longer description of foobar.
       *
       * Return: Description of return value of foobar.
       */
      int foobar(int arg)
      

      Attachments

        Issue Links

          Activity

            [LU-9633] Add kernel-doc style comments to All lustre Code describing function & parameters.

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59979
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (19)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: a0d55213e3d992dd07e048faa997e7a60840db6b

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59979 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (19) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: a0d55213e3d992dd07e048faa997e7a60840db6b

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59978
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (18)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 7ce32da364d1717aee8dabe90900d7ebc38ec3f5

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59978 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (18) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 7ce32da364d1717aee8dabe90900d7ebc38ec3f5

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59977
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (17)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: d8acc6fa53d1a3ba0b9f895f27b133eca5f5a0fb

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59977 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (17) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: d8acc6fa53d1a3ba0b9f895f27b133eca5f5a0fb

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59976
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (16)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: a4b6de2e75fd4f1918ce2699d14d26e164047678

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59976 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (16) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: a4b6de2e75fd4f1918ce2699d14d26e164047678

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59875
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (15)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 4b3da6026207f38807d58040550136610b88bc55

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59875 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (15) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 4b3da6026207f38807d58040550136610b88bc55

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59759
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (14)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: b8708b8646be5dc7fd2544345916aa11f4a61422

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59759 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (14) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: b8708b8646be5dc7fd2544345916aa11f4a61422

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59758
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (13)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: e2272f55c2b70d314fd9fa406a5b69a3d6700e4d

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59758 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (13) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: e2272f55c2b70d314fd9fa406a5b69a3d6700e4d

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59757
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (12)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 90d7e02213cfabfc9c7f26c3c1d0b9f7b3a4f510

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59757 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (12) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 90d7e02213cfabfc9c7f26c3c1d0b9f7b3a4f510

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59756
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (11)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 01fd8b2841c66129a78037fff60b1aa53c0c1b46

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59756 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (11) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 01fd8b2841c66129a78037fff60b1aa53c0c1b46

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59663
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (10)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 2331d6f75712fb35a6ae9f5fece1de96ec318973

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59663 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (10) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 2331d6f75712fb35a6ae9f5fece1de96ec318973

            "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59518
            Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (9)
            Project: fs/lustre-release
            Branch: master
            Current Patch Set: 1
            Commit: 0875843987a18eef0a79d39ac187305d7f5ab425

            gerrit Gerrit Updater added a comment - "Arshad Hussain <arshad.hussain@aeoncomputing.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59518 Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (9) Project: fs/lustre-release Branch: master Current Patch Set: 1 Commit: 0875843987a18eef0a79d39ac187305d7f5ab425

            People

              arshad512 Arshad Hussain
              arshad512 Arshad Hussain
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated: