All of lore.kernel.org
 help / color / mirror / Atom feed
From: 司延腾 <siyanteng@loongson.cn>
To: "Namjae Jeon" <namjae.jeon@samsung.com>
Cc: mchehab+huawei@kernel.org,
	"'Steve French'" <stfrench@microsoft.com>,
	"'Gibeom Kim'" <gibeomii.kim@samsung.com>,
	linux-doc@vger.kernel.org, "'Huacai chen'" <chenhuacai@gmail.com>,
	siyanteng@gmail.com, "'Jonathan Corbet'" <corbet@lwn.net>
Subject: Re: RE: RE: [PATCH 2/2]  docs: filesystems: add cifs to the index file
Date: Sun, 21 Mar 2021 16:49:34 +0800 (GMT+08:00)	[thread overview]
Message-ID: <6571ffec.19c5.17853f9ac3a.Coremail.siyanteng@loongson.cn> (raw)
In-Reply-To: <000e01d71c70$eeb6a0e0$cc23e2a0$@samsung.com>


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; -----原始邮件-----
&gt; 发件人: "Namjae Jeon" <namjae.jeon@samsung.com>
&gt; 发送时间: 2021-03-19 11:35:39 (星期五)
&gt; 收件人: "'司延腾'" <siyanteng@loongson.cn>
&gt; 抄送: mchehab+huawei@kernel.org, "'Steve French'" <stfrench@microsoft.com>, "'Gibeom Kim'" <gibeomii.kim@samsung.com>, linux-doc@vger.kernel.org, "'Huacai chen'" <chenhuacai@gmail.com>, siyanteng@gmail.com, "'Jonathan
&gt;  Corbet'" <corbet@lwn.net>
&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@samsung.com>写道:
&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@samsung.com>
&gt; 
&gt;


</corbet@lwn.net></chenhuacai@gmail.com></gibeomii.kim@samsung.com></stfrench@microsoft.com></siyanteng@loongson.cn></namjae.jeon@samsung.com>

      reply	other threads:[~2021-03-21  8:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-18  3:26 [PATCH 0/2] docs/filesystems:fixes two build warnings Yanteng Si
2021-03-18  3:26 ` [PATCH 1/2] docs: filesystems: cifsd: fix document title markup Yanteng Si
2021-03-18  3:43   ` Namjae Jeon
2021-03-18  3:26 ` [PATCH 2/2] docs: filesystems: add cifs to the index file Yanteng Si
2021-03-18  3:47   ` Namjae Jeon
2021-03-19  2:08     ` 司延腾
2021-03-19  3:35       ` Namjae Jeon
2021-03-21  8:49         ` 司延腾 [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6571ffec.19c5.17853f9ac3a.Coremail.siyanteng@loongson.cn \
    --to=siyanteng@loongson.cn \
    --cc=chenhuacai@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gibeomii.kim@samsung.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=namjae.jeon@samsung.com \
    --cc=siyanteng@gmail.com \
    --cc=stfrench@microsoft.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.