https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LU-8919 Lustre <p>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 <a href="http://kernel.readthedocs.io/en/latest/kernel-documentation.html#sphinx-build" class="external-link" target="_blank" rel="nofollow noopener">http://kernel.readthedocs.io/en/latest/kernel-documentation.html#sphinx-build</a></p> LU-8919

Move to new kernel documentation API

Improvement Minor Closed Duplicate Steve Guminski James A Simmons Wed, 7 Dec 2016 21:14:45 +0000 Tue, 13 Jun 2017 23:06:10 +0000 Tue, 13 Jun 2017 23:06:10 +0000 Lustre 2.10.0 0 6 <p>Are you planning on doing this work James?</p> <p>I can but it might be a bit before I get to it since I have a lot on my plate.</p> <p>James</p> <p>Ok then let's find someone else to help</p> <p>Steve</p> <p>Could you please assist with this one?</p> <p>Thanks</p> <p>Peter</p> <p>Sure, I'll start diving into it tomorrow morning. James, I might have a few questions, so I'd appreciate your continued help.</p> <p>Sure, glad to help</p> <p>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 <b>new</b> comments for code that is missing it, or improving the man pages (e.g. <a href="https://jira.whamcloud.com/browse/LU-7648" title="split lctl lfsck sub-commands to new man pages" class="issue-link" data-issue-key="LU-7648"><del>LU-7648</del></a>) rather than spending time and effort to reformat existing comments to meet some new formatting style.  The comment reformatting benefits almost nobody.</p> <p>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.</p> <p>I think that it is ok for Steve to own this for now, even if it is not his top priority</p> <p>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.</p> <p><a href="https://jira.whamcloud.com/browse/LU-9633" title="Add kernel-doc style comments to All lustre Code describing function &amp; parameters." class="issue-link" data-issue-key="LU-9633">LU-9633</a> is better set up to handle this</p> Related LU-6215 Development Rank 1|hzyxun: Rank (Obsolete) 9223372036854775807 Severity