[v2,3/3] docs: filesystems: Add mount map description in Content
diff mbox series

Message ID 20191117172436.8831-4-jaskaransingh7654321@gmail.com
State Accepted
Commit e8a9e30d721196951e1c82bae208296d066ac272
Headers show
Series
  • docs: filesystems: convert autofs.txt to reST
Related show

Commit Message

Jaskaran Singh Nov. 17, 2019, 5:24 p.m. UTC
The second paragraph of the content section does not properly
describe how mount points are determined by autofs.

Replace the lines detailing how the determination of these mount
points is "ad hoc" by a short description of the mount map syntax
used by autofs.

Signed-off-by: Jaskaran Singh <jaskaransingh7654321@gmail.com>
---
 Documentation/filesystems/autofs.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Ian Kent Nov. 17, 2019, 11:50 p.m. UTC | #1
On Sun, 2019-11-17 at 22:54 +0530, Jaskaran Singh wrote:
> The second paragraph of the content section does not properly
> describe how mount points are determined by autofs.
> 
> Replace the lines detailing how the determination of these mount
> points is "ad hoc" by a short description of the mount map syntax
> used by autofs.
> 
> Signed-off-by: Jaskaran Singh <jaskaransingh7654321@gmail.com>
> ---
>  Documentation/filesystems/autofs.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/filesystems/autofs.rst
> b/Documentation/filesystems/autofs.rst
> index 2f704e9c5dc0..c17f6bf0eb5d 100644
> --- a/Documentation/filesystems/autofs.rst
> +++ b/Documentation/filesystems/autofs.rst
> @@ -49,9 +49,10 @@ extra properties as described in the next section.
>  Objects can only be created by the automount daemon: symlinks are
>  created with a regular `symlink` system call, while directories and
>  mount traps are created with `mkdir`.  The determination of whether
> a
> -directory should be a mount trap or not is quite ad hoc, largely for
> -historical reasons, and is determined in part by the
> -*direct*/*indirect*/*offset* mount options, and the *maxproto* mount
> option.
> +directory should be a mount trap is based on a master map. This
> master
> +map is consulted by autofs to determine which directories are mount
> +points. Mount points can be *direct*/*indirect*/*offset*.
> +On most systems, the default master map is located at
> */etc/auto.master*.

Ok, lets just use this for now since it's better than what was
originally there and I'll put together an update after these
changes are merged.

What happens is actually a bit more complicated, the opening
sentence above this is talking about what happens with maps
associated with autofs mount points given in the master map,
not so much master map entries themselves.

>  
>  If neither the *direct* or *offset* mount options are given (so the
>  mount is considered to be *indirect*), then the root directory is

Patch
diff mbox series

diff --git a/Documentation/filesystems/autofs.rst b/Documentation/filesystems/autofs.rst
index 2f704e9c5dc0..c17f6bf0eb5d 100644
--- a/Documentation/filesystems/autofs.rst
+++ b/Documentation/filesystems/autofs.rst
@@ -49,9 +49,10 @@  extra properties as described in the next section.
 Objects can only be created by the automount daemon: symlinks are
 created with a regular `symlink` system call, while directories and
 mount traps are created with `mkdir`.  The determination of whether a
-directory should be a mount trap or not is quite ad hoc, largely for
-historical reasons, and is determined in part by the
-*direct*/*indirect*/*offset* mount options, and the *maxproto* mount option.
+directory should be a mount trap is based on a master map. This master
+map is consulted by autofs to determine which directories are mount
+points. Mount points can be *direct*/*indirect*/*offset*.
+On most systems, the default master map is located at */etc/auto.master*.
 
 If neither the *direct* or *offset* mount options are given (so the
 mount is considered to be *indirect*), then the root directory is