From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Alexey Dobriyan <adobriyan@gmail.com>,
Kees Cook <keescook@chromium.org>,
Alexey Gladkov <gladkov.alexey@gmail.com>,
"Eric W. Biederman" <ebiederm@xmission.com>,
linux-fsdevel@vger.kernel.org
Subject: [PATCH 29/29] docs: fs: proc.rst: convert a new chapter to ReST
Date: Mon, 15 Jun 2020 08:47:08 +0200 [thread overview]
Message-ID: <cbf1cc9a0cae1238aa3c741f0aa4e2936fd3fd2a.1592203542.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592203542.git.mchehab+huawei@kernel.org>
A new chapter was added to proc.rst. Adjust the markups
to avoid this warning:
Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.
And to properly mark the code-blocks there.
Fixes: 37e7647a7212 ("docs: proc: add documentation for "hidepid=4" and "subset=pid" options and new mount behavior")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/filesystems/proc.rst | 44 ++++++++++++++----------------
1 file changed, 21 insertions(+), 23 deletions(-)
diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 53a0230a08e2..cc0fd2685562 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -2179,46 +2179,44 @@ subset=pid hides all top level files and directories in the procfs that
are not related to tasks.
5 Filesystem behavior
-----------------------------
+---------------------------
Originally, before the advent of pid namepsace, procfs was a global file
system. It means that there was only one procfs instance in the system.
When pid namespace was added, a separate procfs instance was mounted in
each pid namespace. So, procfs mount options are global among all
-mountpoints within the same namespace.
+mountpoints within the same namespace::
-::
+ # grep ^proc /proc/mounts
+ proc /proc proc rw,relatime,hidepid=2 0 0
-# grep ^proc /proc/mounts
-proc /proc proc rw,relatime,hidepid=2 0 0
+ # strace -e mount mount -o hidepid=1 -t proc proc /tmp/proc
+ mount("proc", "/tmp/proc", "proc", 0, "hidepid=1") = 0
+ +++ exited with 0 +++
-# strace -e mount mount -o hidepid=1 -t proc proc /tmp/proc
-mount("proc", "/tmp/proc", "proc", 0, "hidepid=1") = 0
-+++ exited with 0 +++
-
-# grep ^proc /proc/mounts
-proc /proc proc rw,relatime,hidepid=2 0 0
-proc /tmp/proc proc rw,relatime,hidepid=2 0 0
+ # grep ^proc /proc/mounts
+ proc /proc proc rw,relatime,hidepid=2 0 0
+ proc /tmp/proc proc rw,relatime,hidepid=2 0 0
and only after remounting procfs mount options will change at all
-mountpoints.
+mountpoints::
-# mount -o remount,hidepid=1 -t proc proc /tmp/proc
+ # mount -o remount,hidepid=1 -t proc proc /tmp/proc
-# grep ^proc /proc/mounts
-proc /proc proc rw,relatime,hidepid=1 0 0
-proc /tmp/proc proc rw,relatime,hidepid=1 0 0
+ # grep ^proc /proc/mounts
+ proc /proc proc rw,relatime,hidepid=1 0 0
+ proc /tmp/proc proc rw,relatime,hidepid=1 0 0
This behavior is different from the behavior of other filesystems.
The new procfs behavior is more like other filesystems. Each procfs mount
creates a new procfs instance. Mount options affect own procfs instance.
It means that it became possible to have several procfs instances
-displaying tasks with different filtering options in one pid namespace.
+displaying tasks with different filtering options in one pid namespace::
-# mount -o hidepid=invisible -t proc proc /proc
-# mount -o hidepid=noaccess -t proc proc /tmp/proc
-# grep ^proc /proc/mounts
-proc /proc proc rw,relatime,hidepid=invisible 0 0
-proc /tmp/proc proc rw,relatime,hidepid=noaccess 0 0
+ # mount -o hidepid=invisible -t proc proc /proc
+ # mount -o hidepid=noaccess -t proc proc /tmp/proc
+ # grep ^proc /proc/mounts
+ proc /proc proc rw,relatime,hidepid=invisible 0 0
+ proc /tmp/proc proc rw,relatime,hidepid=noaccess 0 0
--
2.26.2
next prev parent reply other threads:[~2020-06-15 6:48 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1592203542.git.mchehab+huawei@kernel.org>
2020-06-15 6:46 ` [PATCH 01/29] mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 02/29] net: dev: add a missing kernel-doc annotation Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 03/29] net: netdevice.h: add a description for napi_defer_hard_irqs Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 04/29] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 05/29] net: pylink.h: add kernel-doc descriptions for new fields at phylink_config Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 06/29] scripts/kernel-doc: handle function pointer prototypes Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description Mauro Carvalho Chehab
2020-06-15 8:47 ` Jan Kara
2020-06-15 6:46 ` [PATCH 08/29] gpio: driver.h: fix kernel-doc markup Mauro Carvalho Chehab
2020-06-15 8:05 ` Bartosz Golaszewski
2020-06-15 6:46 ` [PATCH 09/29] kcsan: fix a kernel-doc warning Mauro Carvalho Chehab
2020-06-15 6:56 ` Marco Elver
2020-06-15 6:46 ` [PATCH 10/29] rcu: fix some kernel-doc warnings Mauro Carvalho Chehab
2020-06-15 20:36 ` Paul E. McKenney
2020-06-15 6:46 ` [PATCH 11/29] fs: docs: f2fs.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 12/29] dt: update a reference for reneases pcar file renamed to yaml Mauro Carvalho Chehab
2020-06-15 7:38 ` Geert Uytterhoeven
2020-06-18 16:41 ` Rob Herring
2020-06-15 6:46 ` [PATCH 13/29] dt: fix broken links due to txt->yaml renames Mauro Carvalho Chehab
2020-06-15 8:13 ` Thomas Bogendoerfer
2020-06-15 11:19 ` Mark Brown
2020-06-15 11:57 ` Mauro Carvalho Chehab
2020-06-15 12:01 ` Mark Brown
2020-06-18 16:44 ` Rob Herring
2020-06-15 6:46 ` [PATCH 14/29] dt: Fix broken references to renamed docs Mauro Carvalho Chehab
2020-06-15 7:48 ` Philipp Zabel
2020-06-15 11:18 ` Mark Brown
2020-06-18 17:06 ` Rob Herring
2020-06-15 6:46 ` [PATCH 15/29] dt: fix reference to olpc,xo1.75-ec.txt Mauro Carvalho Chehab
2020-06-16 8:20 ` Lubomir Rintel
2020-06-18 17:19 ` Rob Herring
2020-06-15 6:46 ` [PATCH 16/29] selftests/vm/keys: fix a broken reference at protection_keys.c Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 17/29] docs: hugetlbpage.rst: fix some warnings Mauro Carvalho Chehab
2020-06-15 11:52 ` Matthew Wilcox
2020-06-15 6:46 ` [PATCH 18/29] docs: powerpc: fix some issues at vas-api.rst Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 19/29] docs: driver-model: remove a duplicated markup at driver.rst Mauro Carvalho Chehab
2020-06-15 6:46 ` [PATCH 20/29] docs: watch_queue.rst: supress some Sphinx warnings and move to core-api Mauro Carvalho Chehab
2020-06-15 6:47 ` [PATCH 21/29] docs: device-mapper: add dm-ebs.rst to an index file Mauro Carvalho Chehab
2020-06-19 16:18 ` Mike Snitzer
2020-06-15 6:47 ` [PATCH 22/29] docs: it_IT: add two missing references Mauro Carvalho Chehab
2020-06-15 7:39 ` Federico Vaga
2020-06-15 6:47 ` [PATCH 23/29] docs: ABI: fix a typo when pointing to w1-generic.rst Mauro Carvalho Chehab
2020-06-15 6:47 ` [PATCH 24/29] docs: fs: locking.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15 6:47 ` [PATCH 25/29] docs: add bus-virt-phys-mapping.txt to core-api Mauro Carvalho Chehab
2020-06-15 6:47 ` [PATCH 26/29] docs: fix references for DMA*.txt files Mauro Carvalho Chehab
2020-06-15 20:37 ` Paul E. McKenney
2020-06-15 6:47 ` [PATCH 27/29] docs: dt: minor adjustments at writing-schema.rst Mauro Carvalho Chehab
2020-06-18 17:20 ` Rob Herring
2020-06-15 6:47 ` [PATCH 28/29] docs: fs: proc.rst: fix a warning due to a merge conflict Mauro Carvalho Chehab
2020-06-15 11:17 ` Mark Brown
2020-06-15 18:24 ` Kees Cook
2020-06-15 6:47 ` Mauro Carvalho Chehab [this message]
2020-06-15 18:24 ` [PATCH 29/29] docs: fs: proc.rst: convert a new chapter to ReST Kees Cook
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=cbf1cc9a0cae1238aa3c741f0aa4e2936fd3fd2a.1592203542.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=adobriyan@gmail.com \
--cc=corbet@lwn.net \
--cc=ebiederm@xmission.com \
--cc=gladkov.alexey@gmail.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).