Commit c64d3dc6 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: filesystems: convert autofs-mount-control.txt to ReST 



- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8cae057ae244d0f5b58d3c209bcdae5ed82bc52c.1581955849.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent ca6e9049

Documentation/filesystems/autofs-mount-control.txt→Documentation/filesystems/autofs-mount-control.rst

+55 −53
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



====================================================================

Miscellaneous Device control operations for the autofs kernel module

====================================================================
@@ -36,12 +38,12 @@ For example, there are two types of automount maps, direct (in the kernel 
module source you will see a third type called an offset, which is just

a direct mount in disguise) and indirect.



Here is a master map with direct and indirect map entries:

Here is a master map with direct and indirect map entries::



    /-      /etc/auto.direct

    /test   /etc/auto.indirect



and the corresponding map files:

and the corresponding map files::



    /etc/auto.direct:
@@ -49,7 +51,7 @@ and the corresponding map files: 
    /automount/dparse/g1  shark:/autofs/export1

    and so on.



/etc/auto.indirect:

/etc/auto.indirect::



    g1    shark:/autofs/export1

    g6    budgie:/autofs/export1
@@ -69,7 +71,7 @@ use the follow_link inode operation to trigger the mount. 
But, each entry in direct and indirect maps can have offsets (making

them multi-mount map entries).



For example, an indirect mount map entry could also be:

For example, an indirect mount map entry could also be::



    g1  \

    /        shark:/autofs/export5/testing/test \
@@ -78,7 +80,7 @@ g1 \ 
    /s1/ss1  shark:/autofs/export1 \

    /s2/ss2  shark:/autofs/export2



and a similarly a direct mount map entry could also be:

and a similarly a direct mount map entry could also be::



    /automount/dparse/g1 \

	/       shark:/autofs/export5/testing/test \
@@ -170,7 +172,7 @@ autofs Miscellaneous Device mount control interface 
The control interface is opening a device node, typically /dev/autofs.



All the ioctls use a common structure to pass the needed parameter

information and return operation results:

information and return operation results::



    struct autofs_dev_ioctl {

	    __u32 ver_major;
@@ -212,7 +214,7 @@ is used account for the increased structure length when translating the 
structure sent from user space.



This structure can be initialized before setting specific fields by using

the void function call init_autofs_dev_ioctl(struct autofs_dev_ioctl *).

the void function call init_autofs_dev_ioctl(``struct autofs_dev_ioctl *``).



All of the ioctls perform a copy of this structure from user space to

kernel space and return -EINVAL if the size parameter is smaller than

Documentation/filesystems/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ Documentation for filesystem implementations. 
   affs

   afs

   autofs

   autofs-mount-control

   fuse

   overlayfs

   virtiofs