[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/+/60160/
Subject: LU-9633 osp: Add kernel doc style for osp (2)
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: a0ad71074331e44b9a9a05c8d254ab3350fc7aff

[Gerrit Updater]

"Oleg Drokin <[e-mail]>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/60159/
Subject: LU-9633 osp: Add kernel doc style for osp (1)
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: cada51a83761cc880dd9e731c5e093b1b7fca9ab

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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