docs: filesystems: convert udf.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 17 Feb 2020 16:12:29 +0000 (17:12 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 2 Mar 2020 21:04:52 +0000 (14:04 -0700)
- Add a SPDX header;
- Add a document title;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/2887f8a3a813a31170389eab687e9f199327dc7d.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/index.rst
Documentation/filesystems/udf.rst [moved from Documentation/filesystems/udf.txt with 83% similarity]

index 58d57c9..ec03cb4 100644 (file)
@@ -92,5 +92,6 @@ Documentation for filesystem implementations.
    tmpfs
    ubifs
    ubifs-authentication.rst
+   udf
    virtiofs
    vfat
similarity index 83%
rename from Documentation/filesystems/udf.txt
rename to Documentation/filesystems/udf.rst
index e2f2faf..d9badbf 100644 (file)
@@ -1,6 +1,8 @@
-*
-* Documentation/filesystems/udf.txt
-*
+.. SPDX-License-Identifier: GPL-2.0
+
+===============
+UDF file system
+===============
 
 If you encounter problems with reading UDF discs using this driver,
 please report them according to MAINTAINERS file.
@@ -18,8 +20,10 @@ performance due to very poor read-modify-write support supplied internally
 by drive firmware.
 
 -------------------------------------------------------------------------------
+
 The following mount options are supported:
 
+       ===========     ======================================
        gid=            Set the default group.
        umask=          Set the default umask.
        mode=           Set the default file permissions.
@@ -34,6 +38,7 @@ The following mount options are supported:
        longad          Use long ad's (default)
        nostrict        Unset strict conformance
        iocharset=      Set the NLS character set
+       ===========     ======================================
 
 The uid= and gid= options need a bit more explaining.  They will accept a
 decimal numeric value and all inodes on that mount will then appear as
@@ -47,13 +52,17 @@ the interactive user will always see the files on the disk as belonging to him.
 
 The remaining are for debugging and disaster recovery:
 
-       novrs           Skip volume sequence recognition 
+       =====           ================================
+       novrs           Skip volume sequence recognition
+       =====           ================================
 
 The following expect a offset from 0.
 
+       ==========      =================================================
        session=        Set the CDROM session (default= last session)
        anchor=         Override standard anchor location. (default= 256)
        lastblock=      Set the last block of the filesystem/
+       ==========      =================================================
 
 -------------------------------------------------------------------------------
 
@@ -62,5 +71,5 @@ For the latest version and toolset see:
        https://github.com/pali/udftools
 
 Documentation on UDF and ECMA 167 is available FREE from:
-       http://www.osta.org/
-       http://www.ecma-international.org/
+       http://www.osta.org/
+       http://www.ecma-international.org/