[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]

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

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

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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

[Gerrit Updater]

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