[PATCH 1/2] doc: filesystems: proc: Remove stray '-' preventing table output

[PATCH 1/2] doc: filesystems: proc: Remove stray '-' preventing table output

[Chris Packham]

When processing proc.rst sphinx complained

  Documentation/filesystems/proc.rst:548: WARNING: Malformed table.
  Text in column margin in table line 29.

This caused the entire table to be dropped. Removing the stray '-'
resolves the error and produces the desired table.

Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---
 Documentation/filesystems/proc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 996f3cfe7030..53a0230a08e2 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -545,7 +545,7 @@ encoded manner. The codes are the following:
     hg    huge page advise flag
     nh    no huge page advise flag
     mg    mergable advise flag
-    bt  - arm64 BTI guarded page
+    bt    arm64 BTI guarded page
     ==    =======================================
 
 Note that there is no guarantee that every flag and associated mnemonic will
-- 
2.27.0

[PATCH 2/2] doc: filesystems: proc: Fix literal blocks

[Chris Packham]

Sphinx complains

  Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.

Update the command line snippets to be properly formed literal blocks.

Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---
 Documentation/filesystems/proc.rst | 38 +++++++++++++++++-------------
 1 file changed, 21 insertions(+), 17 deletions(-)

diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 53a0230a08e2..6027dc94755f 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -2190,25 +2190,27 @@ 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.
 
-# 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.
 
@@ -2217,8 +2219,10 @@ 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.
 
-# 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.27.0

Re: [PATCH 1/2] doc: filesystems: proc: Remove stray '-' preventing table output

[Mike Rapoport]

On Tue, Jul 14, 2020 at 09:06:43PM +1200, Chris Packham wrote:
> When processing proc.rst sphinx complained
> 
>   Documentation/filesystems/proc.rst:548: WARNING: Malformed table.
>   Text in column margin in table line 29.
> 
> This caused the entire table to be dropped. Removing the stray '-'
> resolves the error and produces the desired table.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>

Acked-by: Mike Rapoport <rppt@linux.ibm.com>

> ---
>  Documentation/filesystems/proc.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 996f3cfe7030..53a0230a08e2 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -545,7 +545,7 @@ encoded manner. The codes are the following:
>      hg    huge page advise flag
>      nh    no huge page advise flag
>      mg    mergable advise flag
> -    bt  - arm64 BTI guarded page
> +    bt    arm64 BTI guarded page
>      ==    =======================================
>  
>  Note that there is no guarantee that every flag and associated mnemonic will
> -- 
> 2.27.0
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH 2/2] doc: filesystems: proc: Fix literal blocks

[Mike Rapoport]

On Tue, Jul 14, 2020 at 09:06:44PM +1200, Chris Packham wrote:
> Sphinx complains
> 
>   Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.
> 
> Update the command line snippets to be properly formed literal blocks.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>

Acked-by: Mike Rapoport <rppt@linux.ibm.com>

> ---
>  Documentation/filesystems/proc.rst | 38 +++++++++++++++++-------------
>  1 file changed, 21 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 53a0230a08e2..6027dc94755f 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -2190,25 +2190,27 @@ 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.
>  
> -# 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.
>  
> @@ -2217,8 +2219,10 @@ 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.
>  
> -# 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.27.0
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH 1/2] doc: filesystems: proc: Remove stray '-' preventing table output

[Jonathan Corbet]

On Tue, 14 Jul 2020 21:06:43 +1200
Chris Packham <chris.packham@alliedtelesis.co.nz> wrote:

> When processing proc.rst sphinx complained
> 
>   Documentation/filesystems/proc.rst:548: WARNING: Malformed table.
>   Text in column margin in table line 29.
> 
> This caused the entire table to be dropped. Removing the stray '-'
> resolves the error and produces the desired table.
> 
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> ---
>  Documentation/filesystems/proc.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 996f3cfe7030..53a0230a08e2 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -545,7 +545,7 @@ encoded manner. The codes are the following:
>      hg    huge page advise flag
>      nh    no huge page advise flag
>      mg    mergable advise flag
> -    bt  - arm64 BTI guarded page
> +    bt    arm64 BTI guarded page
>      ==    =======================================

Which tree are you looking at?  Mauro fixed this back in June...

Thanks,

jon

Re: [PATCH 1/2] doc: filesystems: proc: Remove stray '-' preventing table output

[Chris Packham]

On 15/07/20 1:51 am, Jonathan Corbet wrote:
> On Tue, 14 Jul 2020 21:06:43 +1200
> Chris Packham <chris.packham@alliedtelesis.co.nz> wrote:
>
>> When processing proc.rst sphinx complained
>>
>>    Documentation/filesystems/proc.rst:548: WARNING: Malformed table.
>>    Text in column margin in table line 29.
>>
>> This caused the entire table to be dropped. Removing the stray '-'
>> resolves the error and produces the desired table.
>>
>> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
>> ---
>>   Documentation/filesystems/proc.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
>> index 996f3cfe7030..53a0230a08e2 100644
>> --- a/Documentation/filesystems/proc.rst
>> +++ b/Documentation/filesystems/proc.rst
>> @@ -545,7 +545,7 @@ encoded manner. The codes are the following:
>>       hg    huge page advise flag
>>       nh    no huge page advise flag
>>       mg    mergable advise flag
>> -    bt  - arm64 BTI guarded page
>> +    bt    arm64 BTI guarded page
>>       ==    =======================================
> Which tree are you looking at?  Mauro fixed this back in June...
>
> Thanks,

Tip of Linus's tree. Currently points to commit e9919e11e219 ("Merge 
branch 'for-linus' of 
git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input"). I can see 
Mauro's fix waiting in docs-next (probably should have checked there 
first). Feel free to drop this patch.

>
> jon

Re: [PATCH 2/2] doc: filesystems: proc: Fix literal blocks

[Chris Packham]

Hi Jon,

On 14/07/20 9:06 pm, Chris Packham wrote:
> Sphinx complains
>
>    Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.
>
> Update the command line snippets to be properly formed literal blocks.
>
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> ---
>   Documentation/filesystems/proc.rst | 38 +++++++++++++++++-------------
>   1 file changed, 21 insertions(+), 17 deletions(-)
>
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 53a0230a08e2..6027dc94755f 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -2190,25 +2190,27 @@ 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.
>   
> -# 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.
>   
> @@ -2217,8 +2219,10 @@ 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.
>   
> -# 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

Looks like Mauro also fixed this so this can be dropped too.