Re: [PATCH v3 14/15] Documentation: add document for pte_ref

[Qi Zheng]

On 11/10/21 10:39 PM, Jonathan Corbet wrote:
> Qi Zheng <zhengqi.arch@xxxxxxxxxxxxx> writes:
>
> > This commit adds document for pte_ref under `Documentation/vm/`.
>
> Thanks for documenting this work!
>
> > Signed-off-by: Qi Zheng <zhengqi.arch@xxxxxxxxxxxxx>
> > ---
> >   Documentation/vm/pte_ref.rst | 212 +++++++++++++++++++++++++++++++++++++++++++
> >   1 file changed, 212 insertions(+)
> >   create mode 100644 Documentation/vm/pte_ref.rst
>
> When you add a new RST file, you also need to add it to the associated
> index.rst file or it won't be included in the docs build.  Instead,
> you'll get the "not included in any toctree" warning that you surely saw
> when you tested the docs build with this file :)

OK, I will add it to the associated index.rst in the next version.

> > diff --git a/Documentation/vm/pte_ref.rst b/Documentation/vm/pte_ref.rst
> > new file mode 100644
> > index 000000000000..c5323a263464
> > --- /dev/null
> > +++ b/Documentation/vm/pte_ref.rst
> > @@ -0,0 +1,212 @@
> > +.. _pte_ref:
>
> Do you need this label anywhere?  If not, I'd leave it out.

I will remove this label in the next version.

Thanks,
Qi

> Thanks,
>
> jon