[LU-8919] Move to new kernel documentation API Created: 07/Dec/16 Updated: 13/Jun/17 Resolved: 13/Jun/17 |
|
| Status: | Closed |
| Project: | Lustre |
| Component/s: | None |
| Affects Version/s: | Lustre 2.10.0 |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Minor |
| Reporter: | James A Simmons | Assignee: | Steve Guminski (Inactive) |
| Resolution: | Duplicate | Votes: | 0 |
| Labels: | None | ||
| Issue Links: |
|
||||||||
| Severity: | 3 | ||||||||
| Rank (Obsolete): | 9223372036854775807 | ||||||||
| Description |
|
The linux kernel is moving away from DocBook to Sphinx style. Lustre will need to move to this style. Information about this Doc API can be found at http://kernel.readthedocs.io/en/latest/kernel-documentation.html#sphinx-build |
| Comments |
| Comment by Peter Jones [ 07/Dec/16 ] |
|
Are you planning on doing this work James? |
| Comment by James A Simmons [ 07/Dec/16 ] |
|
I can but it might be a bit before I get to it since I have a lot on my plate. |
| Comment by Peter Jones [ 07/Dec/16 ] |
|
James Ok then let's find someone else to help Steve Could you please assist with this one? Thanks Peter |
| Comment by Steve Guminski (Inactive) [ 07/Dec/16 ] |
|
Sure, I'll start diving into it tomorrow morning. James, I might have a few questions, so I'd appreciate your continued help. |
| Comment by James A Simmons [ 07/Dec/16 ] |
|
Sure, glad to help |
| Comment by Andreas Dilger [ 08/Dec/16 ] |
|
James, is this really a priority? I doubt there is much demand for this change to be done before moving the Lustre client out of staging, and if anything I'd prefer effort to be spent on writing new comments for code that is missing it, or improving the man pages (e.g. |
| Comment by James A Simmons [ 08/Dec/16 ] |
|
Not the highest priority. Currently I'm busy with other syncing work. I opened the ticket just to make a note this work needs to be done at some time in the future. Also I like to point out if new comments are added to the lustre kernel source it would be preferable to use this new api. |
| Comment by Peter Jones [ 08/Dec/16 ] |
|
I think that it is ok for Steve to own this for now, even if it is not his top priority |
| Comment by Steve Guminski (Inactive) [ 09/Dec/16 ] |
|
Sounds good, Peter. Andreas sent me a few other higher priority tickets to work, but I'll keep this on my queue and get to it once I've finished with those. |
| Comment by James A Simmons [ 13/Jun/17 ] |
|
LU-9633 is better set up to handle this |