Re: [PATCH] docs/mm: expand vma doc to highlight pte freeing, non-vma traversal

[Jonathan Corbet <corbet@lwn.net>]

Lorenzo Stoakes <lorenzo.stoakes@oracle.com> writes:

> OK thanks for clarifying, so let's do a take 2 of the action items:
>
> 1. Once I am confident I have correctly addressed Jann's feedback I'll
>    respin a v2 with the various 'sins' in place for the time being.
>
> 2. I will also drop the 'since v6.14' stuff you rightly raised in this
> respin.
>
> 3. I will create a follow-up series to address these issues in this file
>    -in general-.
>
> 4. Drop '!' from every reference so we get automated cross-referencing (with the
>    ** struct ** hack as needed).
>
> 5. Where possible see if we have functions documented, and if so avoid the
>    :c:... noise. If we can't avoid it for now, note down the functions and add
>    to todo to get documented. We can remove the gunk as we go...

This one I don't get - what is the noise you are talking about?  Again,
you shouldn't need :c:func: at all...?

There will surely be functions (and structs) that are not documented;
trying to do them all probably leads to a point of diminishing returns.
But forward progress on the more important ones is always good.

> A couple questions on point 5:
>
> - When you say 'documentation', do you mean the /** kernel-doc stuff?

Yes, that is the documentation that will be cross-referenced.

> - Does running `make SPHINXDIRS=mm htmldocs` suffice to have this script run? As
>   this is how I've been previewing my changes so far!

Yes, the automarkup extension runs with any Sphinx build.

Thanks,

jon