docs: filesystems: convert affs.txt to ReST

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

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: David Sterba <dsterba@suse.com>
Link: https://lore.kernel.org/r/b44c56befe0e28cbc0eb1b3e281ad7d99737ff16.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/Documentation/filesystems/affs.txt b/Documentation/filesystems/affs.rst
similarity index 86%
rename from Documentation/filesystems/affs.txt
rename to Documentation/filesystems/affs.rst
index 71b63c2b98410cd9d657b9876897fcdb65189076..7f1a40dce6d3d641aef598f0bdf481f567ea457d 100644 (file)
--- a/Documentation/filesystems/affs.txt
+++ b/Documentation/filesystems/affs.rst
@@ -1,9 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================
 Overview of Amiga Filesystems
 =============================
 
 Not all varieties of the Amiga filesystems are supported for reading and
 writing. The Amiga currently knows six different filesystems:
 
+============== ===============================================================
 DOS\0          The old or original filesystem, not really suited for
                hard disks and normally not used on them, either.
                Supported read/write.
@@ -23,6 +27,7 @@ DOS\4         The original filesystem with directory cache. The directory
                sense on hard disks. Supported read only.
 
 DOS\5          The Fast File System with directory cache. Supported read only.
+============== ===============================================================
 
 All of the above filesystems allow block sizes from 512 to 32K bytes.
 Supported block sizes are: 512, 1024, 2048 and 4096 bytes. Larger blocks
@@ -36,14 +41,18 @@ are supported, too.
 Mount options for the AFFS
 ==========================
 
-protect                If this option is set, the protection bits cannot be altered.
+protect
+               If this option is set, the protection bits cannot be altered.
 
-setuid[=uid]   This sets the owner of all files and directories in the file
+setuid[=uid]
+               This sets the owner of all files and directories in the file
                system to uid or the uid of the current user, respectively.
 
-setgid[=gid]   Same as above, but for gid.
+setgid[=gid]
+               Same as above, but for gid.
 
-mode=mode      Sets the mode flags to the given (octal) value, regardless
+mode=mode
+               Sets the mode flags to the given (octal) value, regardless
                of the original permissions. Directories will get an x
                permission if the corresponding r bit is set.
                This is useful since most of the plain AmigaOS files
@@ -53,33 +62,41 @@ nofilenametruncate
                The file system will return an error when filename exceeds
                standard maximum filename length (30 characters).
 
-reserved=num   Sets the number of reserved blocks at the start of the
+reserved=num
+               Sets the number of reserved blocks at the start of the
                partition to num. You should never need this option.
                Default is 2.
 
-root=block     Sets the block number of the root block. This should never
+root=block
+               Sets the block number of the root block. This should never
                be necessary.
 
-bs=blksize     Sets the blocksize to blksize. Valid block sizes are 512,
+bs=blksize
+               Sets the blocksize to blksize. Valid block sizes are 512,
                1024, 2048 and 4096. Like the root option, this should
                never be necessary, as the affs can figure it out itself.
 
-quiet          The file system will not return an error for disallowed
+quiet
+               The file system will not return an error for disallowed
                mode changes.
 
-verbose                The volume name, file system type and block size will
+verbose
+               The volume name, file system type and block size will
                be written to the syslog when the filesystem is mounted.
 
-mufs           The filesystem is really a muFS, also it doesn't
+mufs
+               The filesystem is really a muFS, also it doesn't
                identify itself as one. This option is necessary if
                the filesystem wasn't formatted as muFS, but is used
                as one.
 
-prefix=path    Path will be prefixed to every absolute path name of
+prefix=path
+               Path will be prefixed to every absolute path name of
                symbolic links on an AFFS partition. Default = "/".
                (See below.)
 
-volume=name    When symbolic links with an absolute path are created
+volume=name
+               When symbolic links with an absolute path are created
                on an AFFS partition, name will be prepended as the
                volume name. Default = "" (empty string).
                (See below.)
@@ -119,7 +136,7 @@ The Linux rwxrwxrwx file mode is handled as follows:
 
   - All other flags (suid, sgid, ...) are ignored and will
     not be retained.
-    
+
 Newly created files and directories will get the user and group ID
 of the current user and a mode according to the umask.
 
@@ -148,11 +165,13 @@ might be "User", "WB" and "Graphics", the mount points /amiga/User,
 Examples
 ========
 
-Command line:
+Command line::
+
     mount  Archive/Amiga/Workbench3.1.adf /mnt -t affs -o loop,verbose
     mount  /dev/sda3 /Amiga -t affs
 
-/etc/fstab entry:
+/etc/fstab entry::
+
     /dev/sdb5  /amiga/Workbench    affs    noauto,user,exec,verbose 0 0
 
 IMPORTANT NOTE
@@ -170,7 +189,8 @@ before booting Windows!
 
 If the damage is already done, the following should fix the RDB
 (where <disk> is the device name).
-DO AT YOUR OWN RISK:
+
+DO AT YOUR OWN RISK::
 
   dd if=/dev/<disk> of=rdb.tmp count=1
   cp rdb.tmp rdb.fixed
@@ -189,10 +209,14 @@ By default, filenames are truncated to 30 characters without warning.
 'nofilenametruncate' mount option can change that behavior.
 
 Case is ignored by the affs in filename matching, but Linux shells
-do care about the case. Example (with /wb being an affs mounted fs):
+do care about the case. Example (with /wb being an affs mounted fs)::
+
     rm /wb/WRONGCASE
-will remove /mnt/wrongcase, but
+
+will remove /mnt/wrongcase, but::
+
     rm /wb/WR*
+
 will not since the names are matched by the shell.
 
 The block allocation is designed for hard disk partitions. If more
@@ -219,4 +243,4 @@ due to an incompatibility with the Amiga floppy controller.
 
 If you are interested in an Amiga Emulator for Linux, look at
 
-http://web.archive.org/web/*/http://www.freiburg.linux.de/~uae/
+http://web.archive.org/web/%2E/http://www.freiburg.linux.de/~uae/

diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 14dc89c948226f4c0f4c7a9c536cb4647461f7df..273d802ad5fb20a79eb86791f7660e9d725ce7b9 100644 (file)
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -48,6 +48,7 @@ Documentation for filesystem implementations.
 
    9p
    adfs
+   affs
    autofs
    fuse
    overlayfs