[PATCH] ovl: fix reStructuredText syntax errors in documentation

[PATCH] ovl: fix reStructuredText syntax errors in documentation

[Amir Goldstein]

- Fix broken long line block quote
- Fix missing newline before bullets list
- Use correct numbered list syntax

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
---
 Documentation/filesystems/overlayfs.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/filesystems/overlayfs.txt b/Documentation/filesystems/overlayfs.txt
index fb6f307..634d03e 100644
--- a/Documentation/filesystems/overlayfs.txt
+++ b/Documentation/filesystems/overlayfs.txt
@@ -66,7 +66,7 @@ At mount time, the two directories given as mount options "lowerdir" and
 "upperdir" are combined into a merged directory:
 
   mount -t overlay overlay -olowerdir=/lower,upperdir=/upper,\
-workdir=/work /merged
+  workdir=/work /merged
 
 The "workdir" needs to be an empty directory on the same filesystem
 as upperdir.
@@ -118,6 +118,7 @@ programs.
 
 seek offsets are assigned sequentially when the directories are read.
 Thus if
+
   - read part of a directory
   - remember an offset, and close the directory
   - re-open the directory some time later
@@ -137,12 +138,12 @@ When renaming a directory that is on the lower layer or merged (i.e. the
 directory was not created on the upper layer to start with) overlayfs can
 handle it in two different ways:
 
-1) return EXDEV error: this error is returned by rename(2) when trying to
+1. return EXDEV error: this error is returned by rename(2) when trying to
    move a file or directory across filesystem boundaries.  Hence
    applications are usually prepared to hande this error (mv(1) for example
    recursively copies the directory tree).  This is the default behavior.
 
-2) If the "redirect_dir" feature is enabled, then the directory will be
+2. If the "redirect_dir" feature is enabled, then the directory will be
    copied up (but not the contents).  Then the "trusted.overlay.redirect"
    extended attribute is set to the path of the original location from the
    root of the overlay.  Finally the directory is moved to the new
-- 
2.7.4

Re: [PATCH] ovl: fix reStructuredText syntax errors in documentation

[Amir Goldstein]

On Thu, Dec 8, 2016 at 9:49 AM, Amir Goldstein <amir73il@gmail.com> wrote:
> - Fix broken long line block quote
> - Fix missing newline before bullets list
> - Use correct numbered list syntax
>

Ping.

Neil,
I found these syntax errors when I posted your page on my wiki:
https://github.com/amir73il/overlayfs/wiki/Overlayfs-overview

Not sure if this patch should go through Miklos's tree or John's tree,
but is surely needs the ACK from you.

Thanks,
Amir.

> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> ---
>  Documentation/filesystems/overlayfs.txt | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/filesystems/overlayfs.txt b/Documentation/filesystems/overlayfs.txt
> index fb6f307..634d03e 100644
> --- a/Documentation/filesystems/overlayfs.txt
> +++ b/Documentation/filesystems/overlayfs.txt
> @@ -66,7 +66,7 @@ At mount time, the two directories given as mount options "lowerdir" and
>  "upperdir" are combined into a merged directory:
>
>    mount -t overlay overlay -olowerdir=/lower,upperdir=/upper,\
> -workdir=/work /merged
> +  workdir=/work /merged
>
>  The "workdir" needs to be an empty directory on the same filesystem
>  as upperdir.
> @@ -118,6 +118,7 @@ programs.
>
>  seek offsets are assigned sequentially when the directories are read.
>  Thus if
> +
>    - read part of a directory
>    - remember an offset, and close the directory
>    - re-open the directory some time later
> @@ -137,12 +138,12 @@ When renaming a directory that is on the lower layer or merged (i.e. the
>  directory was not created on the upper layer to start with) overlayfs can
>  handle it in two different ways:
>
> -1) return EXDEV error: this error is returned by rename(2) when trying to
> +1. return EXDEV error: this error is returned by rename(2) when trying to
>     move a file or directory across filesystem boundaries.  Hence
>     applications are usually prepared to hande this error (mv(1) for example
>     recursively copies the directory tree).  This is the default behavior.
>
> -2) If the "redirect_dir" feature is enabled, then the directory will be
> +2. If the "redirect_dir" feature is enabled, then the directory will be
>     copied up (but not the contents).  Then the "trusted.overlay.redirect"
>     extended attribute is set to the path of the original location from the
>     root of the overlay.  Finally the directory is moved to the new
> --
> 2.7.4
>

Re: [PATCH] ovl: fix reStructuredText syntax errors in documentation

[Jonathan Corbet]

On Thu, 15 Dec 2016 09:58:31 +0200
Amir Goldstein <amir73il@gmail.com> wrote:

> Ping.

Patches that show up right before the merge window opens can get the
back-burner treatment for a bit, sorry.

> Neil,
> I found these syntax errors when I posted your page on my wiki:
> https://github.com/amir73il/overlayfs/wiki/Overlayfs-overview
> 
The "errors" are unsurprising, given that this is not (yet) an RST file.

What we would *really* like to do is integrate this into the growing body
of Sphinx documentation.  That involves thinking about where filesystem
documentation goes in that world, either in the admin manual or into a
new one.

Meanwhile, though, the RST conversion on this file is a fine thing to do,
and I'll be happy to apply the patch once I start working on 4.11 stuff.

Thanks,

jon

Re: [PATCH] ovl: fix reStructuredText syntax errors in documentation

[NeilBrown]

[-- Attachment #1: Type: text/plain, Size: 2786 bytes --]

On Thu, Dec 15 2016, Amir Goldstein wrote:

> On Thu, Dec 8, 2016 at 9:49 AM, Amir Goldstein <amir73il@gmail.com> wrote:
>> - Fix broken long line block quote
>> - Fix missing newline before bullets list
>> - Use correct numbered list syntax
>>
>
> Ping.
>
> Neil,
> I found these syntax errors when I posted your page on my wiki:
> https://github.com/amir73il/overlayfs/wiki/Overlayfs-overview
>
> Not sure if this patch should go through Miklos's tree or John's tree,
> but is surely needs the ACK from you.

Does it?  It is purely format changes which don't change the meaning in
any way, so I felt it had little relevant to me.
However I'm happy to provide an:
  Acked-by: NeilBrown <neilb@suse.com>

if you find that useful.

NeilBrown

>
> Thanks,
> Amir.
>
>> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
>> ---
>>  Documentation/filesystems/overlayfs.txt | 7 ++++---
>>  1 file changed, 4 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/filesystems/overlayfs.txt b/Documentation/filesystems/overlayfs.txt
>> index fb6f307..634d03e 100644
>> --- a/Documentation/filesystems/overlayfs.txt
>> +++ b/Documentation/filesystems/overlayfs.txt
>> @@ -66,7 +66,7 @@ At mount time, the two directories given as mount options "lowerdir" and
>>  "upperdir" are combined into a merged directory:
>>
>>    mount -t overlay overlay -olowerdir=/lower,upperdir=/upper,\
>> -workdir=/work /merged
>> +  workdir=/work /merged
>>
>>  The "workdir" needs to be an empty directory on the same filesystem
>>  as upperdir.
>> @@ -118,6 +118,7 @@ programs.
>>
>>  seek offsets are assigned sequentially when the directories are read.
>>  Thus if
>> +
>>    - read part of a directory
>>    - remember an offset, and close the directory
>>    - re-open the directory some time later
>> @@ -137,12 +138,12 @@ When renaming a directory that is on the lower layer or merged (i.e. the
>>  directory was not created on the upper layer to start with) overlayfs can
>>  handle it in two different ways:
>>
>> -1) return EXDEV error: this error is returned by rename(2) when trying to
>> +1. return EXDEV error: this error is returned by rename(2) when trying to
>>     move a file or directory across filesystem boundaries.  Hence
>>     applications are usually prepared to hande this error (mv(1) for example
>>     recursively copies the directory tree).  This is the default behavior.
>>
>> -2) If the "redirect_dir" feature is enabled, then the directory will be
>> +2. If the "redirect_dir" feature is enabled, then the directory will be
>>     copied up (but not the contents).  Then the "trusted.overlay.redirect"
>>     extended attribute is set to the path of the original location from the
>>     root of the overlay.  Finally the directory is moved to the new
>> --
>> 2.7.4
>>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]