* [PATCH 0/2] docs/filesystems:fixes two build warnings @ 2021-03-18 3:26 Yanteng Si 2021-03-18 3:26 ` [PATCH 1/2] docs: filesystems: cifsd: fix document title markup Yanteng Si 2021-03-18 3:26 ` [PATCH 2/2] docs: filesystems: add cifs to the index file Yanteng Si 0 siblings, 2 replies; 8+ messages in thread From: Yanteng Si @ 2021-03-18 3:26 UTC (permalink / raw) To: Jonathan Corbet Cc: Namjae Jeon, Mauro Carvalho Chehab, Steve French, Gibeom Kim, linux-doc, Huacai chen, siyanteng, Yanteng Si This series of patches fix some warnings: linux-next/Documentation/filesystems/cifs/cifsd.rst:3: WARNING: Title overline too short. ========================= CIFSD - SMB3 Kernel Server ========================= linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: document isn't included in any toctree Yanteng Si(2): docs: filesystems: cifsd: fix document title markup docs: filesystems: add cifs to the index file Signed-off-by: Yanteng Si <siyanteng@loongson.cn> --- Documentation/filesystems/cifs/cifsd.rst | 4 ++-- Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ Documentation/filesystems/index.rst | 2 +- 3 files changed, 15 insertions(+), 3 deletions(-) ^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH 1/2] docs: filesystems: cifsd: fix document title markup 2021-03-18 3:26 [PATCH 0/2] docs/filesystems:fixes two build warnings Yanteng Si @ 2021-03-18 3:26 ` 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 1 sibling, 1 reply; 8+ messages in thread From: Yanteng Si @ 2021-03-18 3:26 UTC (permalink / raw) To: Jonathan Corbet Cc: Namjae Jeon, Mauro Carvalho Chehab, Steve French, Gibeom Kim, linux-doc, Huacai chen, siyanteng, Yanteng Si As warned by sphinx: linux-next/Documentation/filesystems/cifs/cifsd.rst:3: WARNING: Title overline too short. ========================= CIFSD - SMB3 Kernel Server ========================= so,just increase it! --- Documentation/filesystems/cifs/cifsd.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/filesystems/cifs/cifsd.rst b/Documentation/filesystems/cifs/cifsd.rst index e0c33d03f290..af3589da6923 100644 --- a/Documentation/filesystems/cifs/cifsd.rst +++ b/Documentation/filesystems/cifs/cifsd.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0 -========================= +========================== CIFSD - SMB3 Kernel Server -========================= +========================== CIFSD is a linux kernel server which implements SMB3 protocol in kernel space for sharing files over network. -- 2.25.1 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* RE: [PATCH 1/2] docs: filesystems: cifsd: fix document title markup 2021-03-18 3:26 ` [PATCH 1/2] docs: filesystems: cifsd: fix document title markup Yanteng Si @ 2021-03-18 3:43 ` Namjae Jeon 0 siblings, 0 replies; 8+ messages in thread From: Namjae Jeon @ 2021-03-18 3:43 UTC (permalink / raw) To: 'Yanteng Si' Cc: 'Mauro Carvalho Chehab', 'Steve French', 'Gibeom Kim', linux-doc, 'Huacai chen', siyanteng, 'Jonathan Corbet' Hi Yanteng, Thanks for your patch. I have already applied the patch to fix this warning to steve's tree. https://github.com/smfrench/smb3-kernel/commit/801019d874df84f5fa8d21148c2a82edc80785da Thanks! > As warned by sphinx: > > linux-next/Documentation/filesystems/cifs/cifsd.rst:3: WARNING: > Title overline too short. > > ========================= > CIFSD - SMB3 Kernel Server > ========================= > > so,just increase it! > --- > Documentation/filesystems/cifs/cifsd.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/filesystems/cifs/cifsd.rst b/Documentation/filesystems/cifs/cifsd.rst > index e0c33d03f290..af3589da6923 100644 > --- a/Documentation/filesystems/cifs/cifsd.rst > +++ b/Documentation/filesystems/cifs/cifsd.rst > @@ -1,8 +1,8 @@ > .. SPDX-License-Identifier: GPL-2.0 > > -========================= > +========================== > CIFSD - SMB3 Kernel Server > -========================= > +========================== > > CIFSD is a linux kernel server which implements SMB3 protocol in kernel space for sharing files over > network. > -- > 2.25.1 ^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH 2/2] docs: filesystems: add cifs to the index file 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:26 ` Yanteng Si 2021-03-18 3:47 ` Namjae Jeon 1 sibling, 1 reply; 8+ messages in thread From: Yanteng Si @ 2021-03-18 3:26 UTC (permalink / raw) To: Jonathan Corbet Cc: Namjae Jeon, Mauro Carvalho Chehab, Steve French, Gibeom Kim, linux-doc, Huacai chen, siyanteng, Yanteng Si Filesystems has a new cifs folder. Add it to the index file. Should address this warning: linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: document isn't included in any toctree --- Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ Documentation/filesystems/index.rst | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 Documentation/filesystems/cifs/index.rst diff --git a/Documentation/filesystems/cifs/index.rst b/Documentation/filesystems/cifs/index.rst new file mode 100644 index 000000000000..b4a487e9adff --- /dev/null +++ b/Documentation/filesystems/cifs/index.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: GPL-2.0 + +==== +CIFS +==== + +.. toctree:: + :maxdepth: 2 + :numbered: + + cifsd + cifsroot diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index d4853cb919d2..bdba80ae2bb1 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -72,7 +72,7 @@ Documentation for filesystem implementations. befs bfs btrfs - cifs/cifsroot + cifs/index ceph coda configfs -- 2.25.1 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* RE: [PATCH 2/2] docs: filesystems: add cifs to the index file 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 ` 司延腾 0 siblings, 1 reply; 8+ messages in thread From: Namjae Jeon @ 2021-03-18 3:47 UTC (permalink / raw) To: 'Yanteng Si' Cc: 'Mauro Carvalho Chehab', 'Steve French', 'Gibeom Kim', linux-doc, 'Huacai chen', siyanteng, 'Jonathan Corbet' > Filesystems has a new cifs folder. Add it to the index file. > Should address this warning: > > linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: > document isn't included in any toctree > --- > Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ > Documentation/filesystems/index.rst | 2 +- > 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 > Documentation/filesystems/cifs/index.rst > > diff --git a/Documentation/filesystems/cifs/index.rst b/Documentation/filesystems/cifs/index.rst > new file mode 100644 > index 000000000000..b4a487e9adff > --- /dev/null > +++ b/Documentation/filesystems/cifs/index.rst > @@ -0,0 +1,12 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +==== > +CIFS > +==== > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: Could you please explain what :maxdepth and :numbered are ? Thanks! > + > + cifsd > + cifsroot > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > index d4853cb919d2..bdba80ae2bb1 100644 > --- a/Documentation/filesystems/index.rst > +++ b/Documentation/filesystems/index.rst > @@ -72,7 +72,7 @@ Documentation for filesystem implementations. > befs > bfs > btrfs > - cifs/cifsroot > + cifs/index > ceph > coda > configfs > -- > 2.25.1 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: RE: [PATCH 2/2] docs: filesystems: add cifs to the index file 2021-03-18 3:47 ` Namjae Jeon @ 2021-03-19 2:08 ` 司延腾 2021-03-19 3:35 ` Namjae Jeon 0 siblings, 1 reply; 8+ messages in thread From: 司延腾 @ 2021-03-19 2:08 UTC (permalink / raw) To: Namjae Jeon Cc: mchehab+huawei, 'Steve French', 'Gibeom Kim', linux-doc, 'Huacai chen', siyanteng, 'Jonathan Corbet' Sorry, I copied an index as a base from somewhere else and modified it, obviously I didn't do a very nice job and this will cause problems for future developers. Just keep the defaults, can I delete them in v2? Thanks! Yanteng "Namjae Jeon" <namjae.jeon@samsung.com>写道： > > Filesystems has a new cifs folder. Add it to the index file. > > Should address this warning: > > > > linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: > > document isn't included in any toctree > > --- > > Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ > > Documentation/filesystems/index.rst | 2 +- > > 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 > > Documentation/filesystems/cifs/index.rst > > > > diff --git a/Documentation/filesystems/cifs/index.rst b/Documentation/filesystems/cifs/index.rst > > new file mode 100644 > > index 000000000000..b4a487e9adff > > --- /dev/null > > +++ b/Documentation/filesystems/cifs/index.rst > > @@ -0,0 +1,12 @@ > > +.. SPDX-License-Identifier: GPL-2.0 > > + > > +==== > > +CIFS > > +==== > > + > > +.. toctree:: > > + :maxdepth: 2 > > + :numbered: > Could you please explain what :maxdepth and :numbered are ? > > Thanks! > > + > > + cifsd > > + cifsroot > > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > > index d4853cb919d2..bdba80ae2bb1 100644 > > --- a/Documentation/filesystems/index.rst > > +++ b/Documentation/filesystems/index.rst > > @@ -72,7 +72,7 @@ Documentation for filesystem implementations. > > befs > > bfs > > btrfs > > - cifs/cifsroot > > + cifs/index > > ceph > > coda > > configfs > > -- > > 2.25.1 > </namjae.jeon@samsung.com> ^ permalink raw reply [flat|nested] 8+ messages in thread
* RE: RE: [PATCH 2/2] docs: filesystems: add cifs to the index file 2021-03-19 2:08 ` 司延腾 @ 2021-03-19 3:35 ` Namjae Jeon 2021-03-21 8:49 ` 司延腾 0 siblings, 1 reply; 8+ messages in thread From: Namjae Jeon @ 2021-03-19 3:35 UTC (permalink / raw) To: '司延腾' Cc: mchehab+huawei, 'Steve French', 'Gibeom Kim', linux-doc, 'Huacai chen', siyanteng, 'Jonathan Corbet' > Sorry, I copied an index as a base from somewhere else and modified it, obviously I didn't do a very > nice job and this will cause problems for future developers. Just keep the defaults, can I delete them > in v2? Is it really right to delete them? First we have to know what they mean. When I see Documentation/filesystems/nfs/index.st, :maxdepth is set to 1. Can you take a look more ? > Thanks! > > Yanteng > > "Namjae Jeon" <namjae.jeon@samsung.com>写道： > > > Filesystems has a new cifs folder. Add it to the index file. > > > Should address this warning: > > > > > > linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: > > > document isn't included in any toctree > > --- > > > Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ > > > Documentation/filesystems/index.rst | 2 +- > > > 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 > > > Documentation/filesystems/cifs/index.rst > > > > > > diff --git a/Documentation/filesystems/cifs/index.rst > b/Documentation/filesystems/cifs/index.rst > > > new file mode 100644 > > > index 000000000000..b4a487e9adff > > --- /dev/null > > +++ > b/Documentation/filesystems/cifs/index.rst > > > @@ -0,0 +1,12 @@ > > > +.. SPDX-License-Identifier: GPL-2.0 > > + > > +==== > > +CIFS > > > +==== > > + > > +.. toctree:: > > > + :maxdepth: 2 > > > + :numbered: > > Could you please explain what :maxdepth and :numbered are ? > > > > Thanks! > > > + > > > + cifsd > > > + cifsroot > > > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > > > index d4853cb919d2..bdba80ae2bb1 100644 > > --- a/Documentation/filesystems/index.rst > > > +++ b/Documentation/filesystems/index.rst > > > @@ -72,7 +72,7 @@ Documentation for filesystem implementations. > > > befs > > > bfs > > > btrfs > > > - cifs/cifsroot > > > + cifs/index > > > ceph > > > coda > > > configfs > > > -- > > > 2.25.1 > > > > > </namjae.jeon@samsung.com> ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: RE: RE: [PATCH 2/2] docs: filesystems: add cifs to the index file 2021-03-19 3:35 ` Namjae Jeon @ 2021-03-21 8:49 ` 司延腾 0 siblings, 0 replies; 8+ messages in thread From: 司延腾 @ 2021-03-21 8:49 UTC (permalink / raw) To: Namjae Jeon Cc: mchehab+huawei, 'Steve French', 'Gibeom Kim', linux-doc, 'Huacai chen', siyanteng, 'Jonathan Corbet' 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 > -----原始邮件----- > 发件人: "Namjae Jeon" <namjae.jeon@samsung.com> > 发送时间: 2021-03-19 11:35:39 (星期五) > 收件人: "'司延腾'" <siyanteng@loongson.cn> > 抄送: 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> > 主题: RE: RE: [PATCH 2/2] docs: filesystems: add cifs to the index file > > > Sorry, I copied an index as a base from somewhere else and modified it, obviously I didn't do a very > > nice job and this will cause problems for future developers. Just keep the defaults, can I delete them > > in v2? > Is it really right to delete them? First we have to know what they mean. > When I see Documentation/filesystems/nfs/index.st, :maxdepth is set to 1. > Can you take a look more ? > > > Thanks! > > > > Yanteng > > > > "Namjae Jeon" <namjae.jeon@samsung.com>写道： > > > > Filesystems has a new cifs folder. Add it to the index file. > > > > Should address this warning: > > > > > > > > linux-next/Documentation/filesystems/cifs/cifsd.rst: WARNING: > > > > document isn't included in any toctree > > --- > > > > Documentation/filesystems/cifs/index.rst | 12 ++++++++++++ > > > > Documentation/filesystems/index.rst | 2 +- > > > > 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 > > > > Documentation/filesystems/cifs/index.rst > > > > > > > > diff --git a/Documentation/filesystems/cifs/index.rst > > b/Documentation/filesystems/cifs/index.rst > > > > new file mode 100644 > > > > index 000000000000..b4a487e9adff > > --- /dev/null > > +++ > > b/Documentation/filesystems/cifs/index.rst > > > > @@ -0,0 +1,12 @@ > > > > +.. SPDX-License-Identifier: GPL-2.0 > > + > > +==== > > +CIFS > > > > +==== > > + > > +.. toctree:: > > > > + :maxdepth: 2 > > > > + :numbered: > > > Could you please explain what :maxdepth and :numbered are ? > > > > > > Thanks! > > > > + > > > > + cifsd > > > > + cifsroot > > > > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > > > > index d4853cb919d2..bdba80ae2bb1 100644 > > --- a/Documentation/filesystems/index.rst > > > > +++ b/Documentation/filesystems/index.rst > > > > @@ -72,7 +72,7 @@ Documentation for filesystem implementations. > > > > befs > > > > bfs > > > > btrfs > > > > - cifs/cifsroot > > > > + cifs/index > > > > ceph > > > > coda > > > > configfs > > > > -- > > > > 2.25.1 > > > > > > > > > </namjae.jeon@samsung.com> > > </corbet@lwn.net></chenhuacai@gmail.com></gibeomii.kim@samsung.com></stfrench@microsoft.com></siyanteng@loongson.cn></namjae.jeon@samsung.com> ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2021-03-21 8:50 UTC | newest] Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 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 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.