[LU-9633] Add kernel-doc style comments to All lustre Code describing function & parameters. Created: 11/Jun/17 Updated: 10/Sep/20 |
|
| Status: | Open |
| Project: | Lustre |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | Upstream |
| Type: | Epic | Priority: | Minor |
| Reporter: | Arshad Hussain | Assignee: | Arshad Hussain |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Issue Links: |
|
||||||||
| Epic Name: | Add kernel-doc style comments to All lustre Code. | ||||||||
| Rank (Obsolete): | 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) |
| Comments |
| Comment by James A Simmons [ 13/Jun/17 ] |
|
Arshad thanks for taking this up. I have not had the cycles to do this. |
| Comment by James A Simmons [ 12/Feb/18 ] |
|
Arshad are you still interested in this work? |
| Comment by Arshad Hussain [ 29/Apr/19 ] |
|
James, apologies for the delay response. I completely missed your comment until today. Yes, I do have couple of Sphinx related patch's to get started. I should be pushing it very soon. |
| Comment by James A Simmons [ 29/Apr/19 ] |
|
Before we start I pushed the sphinix port to the linux lustre client first. I plan to move the upstream client out of the staging tree so the docs can be tested to see how they turn out. |