some minor improvements to the mountinfo description

4 messages, 2 authors, 2021-10-12 · open the first message on its own page

some minor improvements to the mountinfo description

From: Christoph Anton Mitterer <hidden>
Date: 2021-10-07 04:07:57

Hey there.

Hope these minor patches help & thanks for considering.

Wasn���t sure about the UTF-8 I'm using, but I've seen that some
of the RST files already used ��� so I figured it would be okayish.


Cheers,
Chris.

[PATCH 1/2] docs: proc.rst: mountinfo: improved field numbering

From: Christoph Anton Mitterer <hidden>
Date: 2021-10-07 04:01:14

Without reading thoroughly, one could easily oversee that there may be several
fields after #6.
Made it more clearly by changing the field numbering.

Signed-off-by: Christoph Anton Mitterer <redacted>
---
 Documentation/filesystems/proc.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 042c418f4090..d2542f737a0a 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -1857,7 +1857,7 @@ For example::
 This file contains lines of the form::
 
     36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
-    (1)(2)(3)   (4)   (5)      (6)      (7)   (8) (9)   (10)         (11)
+    (1)(2)(3)   (4)   (5)      (6)     (n…m) (m+1)(m+2) (m+3)         (m+4)
 
     (1) mount ID:  unique identifier of the mount (may be reused after umount)
     (2) parent ID:  ID of parent (or of self for the top of the mount tree)
@@ -1865,11 +1865,11 @@ This file contains lines of the form::
     (4) root:  root of the mount within the filesystem
     (5) mount point:  mount point relative to the process's root
     (6) mount options:  per mount options
-    (7) optional fields:  zero or more fields of the form "tag[:value]"
-    (8) separator:  marks the end of the optional fields
-    (9) filesystem type:  name of filesystem of the form "type[.subtype]"
-    (10) mount source:  filesystem specific information or "none"
-    (11) super options:  per super block options
+    (n…m) optional fields:  zero or more fields of the form "tag[:value]"
+    (m+1) separator:  marks the end of the optional fields
+    (m+2) filesystem type:  name of filesystem of the form "type[.subtype]"
+    (m+3) mount source:  filesystem specific information or "none"
+    (m+4) super options:  per super block options
 
 Parsers should ignore all unrecognised optional fields.  Currently the
 possible optional fields are:
-- 
2.33.0

[PATCH 2/2] docs: proc.rst: mountinfo: align columns

From: Christoph Anton Mitterer <hidden>
Date: 2021-10-07 04:01:15

Signed-off-by: Christoph Anton Mitterer <redacted>
---
 Documentation/filesystems/proc.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index d2542f737a0a..8d7f141c6fc7 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -1859,17 +1859,17 @@ This file contains lines of the form::
     36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue
     (1)(2)(3)   (4)   (5)      (6)     (n…m) (m+1)(m+2) (m+3)         (m+4)
 
-    (1) mount ID:  unique identifier of the mount (may be reused after umount)
-    (2) parent ID:  ID of parent (or of self for the top of the mount tree)
-    (3) major:minor:  value of st_dev for files on filesystem
-    (4) root:  root of the mount within the filesystem
-    (5) mount point:  mount point relative to the process's root
-    (6) mount options:  per mount options
-    (n…m) optional fields:  zero or more fields of the form "tag[:value]"
-    (m+1) separator:  marks the end of the optional fields
-    (m+2) filesystem type:  name of filesystem of the form "type[.subtype]"
-    (m+3) mount source:  filesystem specific information or "none"
-    (m+4) super options:  per super block options
+    (1)   mount ID:        unique identifier of the mount (may be reused after umount)
+    (2)   parent ID:       ID of parent (or of self for the top of the mount tree)
+    (3)   major:minor:     value of st_dev for files on filesystem
+    (4)   root:            root of the mount within the filesystem
+    (5)   mount point:     mount point relative to the process's root
+    (6)   mount options:   per mount options
+    (n…m) optional fields: zero or more fields of the form "tag[:value]"
+    (m+1) separator:       marks the end of the optional fields
+    (m+2) filesystem type: name of filesystem of the form "type[.subtype]"
+    (m+3) mount source:    filesystem specific information or "none"
+    (m+4) super options:   per super block options
 
 Parsers should ignore all unrecognised optional fields.  Currently the
 possible optional fields are:
-- 
2.33.0

Re: some minor improvements to the mountinfo description

From: Jonathan Corbet <corbet@lwn.net>
Date: 2021-10-12 19:53:43

Christoph Anton Mitterer [off-list ref] writes:
Hey there.

Hope these minor patches help & thanks for considering.

Wasn’t sure about the UTF-8 I'm using, but I've seen that some
of the RST files already used … so I figured it would be okayish.
Both patches applied, thanks.

In the future, please, when you include a cover letter, say what the
patch series actually does in that letter.

Thanks,

jon
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help