Re: RE: RE: [PATCH 2/2] docs: filesystems: add cifs to the index file

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Thank you! In the past two days I have consulted not only other indexes, but also the Sphinx manual.  In the meantime I have done a lot of experimentation. Now I am convinced that: ":maxdepth:1" is appropriate; ":numbered" is not needed.
Thanks!

Yanteng
> -----原始邮件-----
&gt; 发件人: "Namjae Jeon" <namjae.jeon@xxxxxxxxxxx>
&gt; 发送时间: 2021-03-19 11:35:39 (星期五)
&gt; 收件人: "'司延腾'" <siyanteng@xxxxxxxxxxx>
&gt; 抄送: mchehab+huawei@xxxxxxxxxx, "'Steve French'" <stfrench@xxxxxxxxxxxxx>, "'Gibeom Kim'" <gibeomii.kim@xxxxxxxxxxx>, linux-doc@xxxxxxxxxxxxxxx, "'Huacai chen'" <chenhuacai@xxxxxxxxx>, siyanteng@xxxxxxxxx, "'Jonathan
&gt;  Corbet'" <corbet@xxxxxxx>
&gt; 主题: RE: RE: [PATCH 2/2]  docs: filesystems: add cifs to the index file
&gt; 
&gt; &gt; Sorry, I copied an index as a base from somewhere else and modified it, obviously I didn't do a very
&gt; &gt; nice job and this will cause problems for future developers. Just keep the defaults, can I delete them
&gt; &gt; in v2?
&gt; Is it really right to delete them? First we have to know what they mean.
&gt; When I see Documentation/filesystems/nfs/index.st, :maxdepth is set to 1.
&gt; Can you take a look more ?
&gt; 
&gt; &gt; Thanks!
&gt; &gt; 
&gt; &gt; Yanteng
&gt; &gt; 
&gt; &gt; "Namjae Jeon" <namjae.jeon@xxxxxxxxxxx>写道:
&gt; &gt; &gt; &gt;     Filesystems has a new cifs folder. Add it to the index file.
&gt; &gt; &gt; &gt;     Should address this warning:
&gt; &gt; &gt; &gt;
&gt; &gt; &gt; &gt;  linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING:
&gt; &gt; &gt; &gt;  document isn't included in any toctree &gt; &gt; --- &gt; &gt;
&gt; &gt; Documentation/filesystems/cifs/index.rst | 12 ++++++++++++
&gt; &gt; &gt; &gt;  Documentation/filesystems/index.rst      |  2 +-
&gt; &gt; &gt; &gt;  2 files changed, 13 insertions(+), 1 deletion(-)  create mode 100644 &gt; &gt;
&gt; &gt; Documentation/filesystems/cifs/index.rst
&gt; &gt; &gt; &gt;
&gt; &gt; &gt; &gt; diff --git a/Documentation/filesystems/cifs/index.rst
&gt; &gt; b/Documentation/filesystems/cifs/index.rst
&gt; &gt; &gt; &gt; new file mode 100644
&gt; &gt; &gt; &gt; index 000000000000..b4a487e9adff &gt; &gt; --- /dev/null &gt; &gt; +++
&gt; &gt; b/Documentation/filesystems/cifs/index.rst
&gt; &gt; &gt; &gt; @@ -0,0 +1,12 @@
&gt; &gt; &gt; &gt; +.. SPDX-License-Identifier: GPL-2.0 &gt; &gt; + &gt; &gt; +==== &gt; &gt; +CIFS &gt; &gt;
&gt; &gt; +==== &gt; &gt; + &gt; &gt; +.. toctree::
&gt; &gt; &gt; &gt; +   :maxdepth: 2
&gt; &gt; &gt; &gt; +   :numbered:
&gt; &gt; &gt; Could you please explain what :maxdepth and :numbered are ?
&gt; &gt; &gt;
&gt; &gt; &gt; Thanks!
&gt; &gt; &gt; &gt; +
&gt; &gt; &gt; &gt; +   cifsd
&gt; &gt; &gt; &gt; +   cifsroot
&gt; &gt; &gt; &gt; diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
&gt; &gt; &gt; &gt; index d4853cb919d2..bdba80ae2bb1 100644 &gt; &gt; --- a/Documentation/filesystems/index.rst
&gt; &gt; &gt; &gt; +++ b/Documentation/filesystems/index.rst
&gt; &gt; &gt; &gt; @@ -72,7 +72,7 @@ Documentation for filesystem implementations.
&gt; &gt; &gt; &gt;     befs
&gt; &gt; &gt; &gt;     bfs
&gt; &gt; &gt; &gt;     btrfs
&gt; &gt; &gt; &gt; -   cifs/cifsroot
&gt; &gt; &gt; &gt; +   cifs/index
&gt; &gt; &gt; &gt;     ceph
&gt; &gt; &gt; &gt;     coda
&gt; &gt; &gt; &gt;     configfs
&gt; &gt; &gt; &gt; --
&gt; &gt; &gt; &gt; 2.25.1
&gt; &gt; &gt;
&gt; &gt; 
&gt; &gt; 
&gt; &gt; </namjae.jeon@xxxxxxxxxxx>
&gt; 
&gt;


</corbet@xxxxxxx></chenhuacai@xxxxxxxxx></gibeomii.kim@xxxxxxxxxxx></stfrench@xxxxxxxxxxxxx></siyanteng@xxxxxxxxxxx></namjae.jeon@xxxxxxxxxxx>




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux