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

• Type: Epic
• Resolution: Unresolved
• Priority: Minor
• Fix Version/s: Upstream
• Labels: dwg
• Epic Name: Add kernel-doc style comments to All lustre Code.
• Assignee: Arshad Hussain
• Reporter: Arshad Hussain

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)

Issue Links

• is related to: LU-12511 Prepare lustre for adoption into the linux kernel
• is related to: LU-1892 In-tree documentation improvements

Comments

[Gerrit Updater]

"Oleg Drokin <[e-mail]>" merged in 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:
Commit: c15fd5c14d3177153fe95ff771751a0975009c51

[Gerrit Updater]

"Arshad Hussain <[e-mail]>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/59980
Subject: LU-9633 ptlrpc: Add kernel doc style for ptlrpc (20)
Project: fs/lustre-release
Branch: master
Current Patch Set: 1
Commit: 70966d03c75f3a5ecc59986f0dd44e9fafffe906

[Gerrit Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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 Updater]

"Arshad Hussain <[e-mail]>" 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