]> www.infradead.org Git - users/dwmw2/linux.git/commitdiff
docs: filesystems: convert adfs.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 17 Feb 2020 16:11:48 +0000 (17:11 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 2 Mar 2020 20:58:44 +0000 (13:58 -0700)
- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/15ee92f03ec917e5d26bd7b863565dec88c843f6.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/adfs.rst [moved from Documentation/filesystems/adfs.txt with 85% similarity]
Documentation/filesystems/index.rst

similarity index 85%
rename from Documentation/filesystems/adfs.txt
rename to Documentation/filesystems/adfs.rst
index 0baa8e8c1fc1985a1cc0498b463087e22bb61ce0..5b22cae38e5e83717dea18520f19448b8a41c90a 100644 (file)
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===============================
+Acorn Disc Filing System - ADFS
+===============================
+
 Filesystems supported by ADFS
 -----------------------------
 
@@ -25,6 +31,7 @@ directory updates, specifically updating the access mode and timestamp.
 Mount options for ADFS
 ----------------------
 
+  ============  ======================================================
   uid=nnn      All files in the partition will be owned by
                user id nnn.  Default 0 (root).
   gid=nnn      All files in the partition will be in group
@@ -36,22 +43,23 @@ Mount options for ADFS
   ftsuffix=n   When ftsuffix=0, no file type suffix will be applied.
                When ftsuffix=1, a hexadecimal suffix corresponding to
                the RISC OS file type will be added.  Default 0.
+  ============  ======================================================
 
 Mapping of ADFS permissions to Linux permissions
 ------------------------------------------------
 
   ADFS permissions consist of the following:
 
-       Owner read
-       Owner write
-       Other read
-       Other write
+       Owner read
+       Owner write
+       Other read
+       Other write
 
   (In older versions, an 'execute' permission did exist, but this
-   does not hold the same meaning as the Linux 'execute' permission
-   and is now obsolete).
+  does not hold the same meaning as the Linux 'execute' permission
+  and is now obsolete).
 
-  The mapping is performed as follows:
+  The mapping is performed as follows::
 
        Owner read                              -> -r--r--r--
        Owner write                             -> --w--w---w
@@ -66,17 +74,18 @@ Mapping of ADFS permissions to Linux permissions
        Possible other mode permissions         -> ----rwxrwx
 
   Hence, with the default masks, if a file is owner read/write, and
-  not a UnixExec filetype, then the permissions will be:
+  not a UnixExec filetype, then the permissions will be::
 
                        -rw-------
 
   However, if the masks were ownmask=0770,othmask=0007, then this would
-  be modified to:
+  be modified to::
+
                        -rw-rw----
 
   There is no restriction on what you can do with these masks.  You may
   wish that either read bits give read access to the file for all, but
-  keep the default write protection (ownmask=0755,othmask=0577):
+  keep the default write protection (ownmask=0755,othmask=0577)::
 
                        -rw-r--r--
 
index a9330c3f8c2ee7e71ced65f711e3d59f57c6a114..14dc89c948226f4c0f4c7a9c536cb4647461f7df 100644 (file)
@@ -47,6 +47,7 @@ Documentation for filesystem implementations.
    :maxdepth: 2
 
    9p
+   adfs
    autofs
    fuse
    overlayfs