docs: filesystems: convert hfsplus.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 17 Feb 2020 16:12:07 +0000 (17:12 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 2 Mar 2020 21:03:47 +0000 (14:03 -0700)
Just trivial changes:

- Add a SPDX header;
- Add it to filesystems/index.rst.

While here, adjust document title, just to make it use the same
style of the other docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4298409da951fbee000201a6c8d9c85e961b2b79.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/hfsplus.rst [new file with mode: 0644]
Documentation/filesystems/hfsplus.txt [deleted file]
Documentation/filesystems/index.rst

diff --git a/Documentation/filesystems/hfsplus.rst b/Documentation/filesystems/hfsplus.rst
new file mode 100644 (file)
index 0000000..f02f4f5
--- /dev/null
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================
+Macintosh HFSPlus Filesystem for Linux
+======================================
+
+HFSPlus is a filesystem first introduced in MacOS 8.1.
+HFSPlus has several extensions to HFS, including 32-bit allocation
+blocks, 255-character unicode filenames, and file sizes of 2^63 bytes.
+
+
+Mount options
+=============
+
+When mounting an HFSPlus filesystem, the following options are accepted:
+
+  creator=cccc, type=cccc
+       Specifies the creator/type values as shown by the MacOS finder
+       used for creating new files.  Default values: '????'.
+
+  uid=n, gid=n
+       Specifies the user/group that owns all files on the filesystem
+       that have uninitialized permissions structures.
+       Default:  user/group id of the mounting process.
+
+  umask=n
+       Specifies the umask (in octal) used for files and directories
+       that have uninitialized permissions structures.
+       Default:  umask of the mounting process.
+
+  session=n
+       Select the CDROM session to mount as HFSPlus filesystem.  Defaults to
+       leaving that decision to the CDROM driver.  This option will fail
+       with anything but a CDROM as underlying devices.
+
+  part=n
+       Select partition number n from the devices.  This option only makes
+       sense for CDROMs because they can't be partitioned under Linux.
+       For disk devices the generic partition parsing code does this
+       for us.  Defaults to not parsing the partition table at all.
+
+  decompose
+       Decompose file name characters.
+
+  nodecompose
+       Do not decompose file name characters.
+
+  force
+       Used to force write access to volumes that are marked as journalled
+       or locked.  Use at your own risk.
+
+  nls=cccc
+       Encoding to use when presenting file names.
+
+
+References
+==========
+
+kernel source:         <file:fs/hfsplus>
+
+Apple Technote 1150    https://developer.apple.com/legacy/library/technotes/tn/tn1150.html
diff --git a/Documentation/filesystems/hfsplus.txt b/Documentation/filesystems/hfsplus.txt
deleted file mode 100644 (file)
index 59f7569..0000000
+++ /dev/null
@@ -1,59 +0,0 @@
-
-Macintosh HFSPlus Filesystem for Linux
-======================================
-
-HFSPlus is a filesystem first introduced in MacOS 8.1.
-HFSPlus has several extensions to HFS, including 32-bit allocation
-blocks, 255-character unicode filenames, and file sizes of 2^63 bytes.
-
-
-Mount options
-=============
-
-When mounting an HFSPlus filesystem, the following options are accepted:
-
-  creator=cccc, type=cccc
-       Specifies the creator/type values as shown by the MacOS finder
-       used for creating new files.  Default values: '????'.
-
-  uid=n, gid=n
-       Specifies the user/group that owns all files on the filesystem
-       that have uninitialized permissions structures.
-       Default:  user/group id of the mounting process.
-
-  umask=n
-       Specifies the umask (in octal) used for files and directories
-       that have uninitialized permissions structures.
-       Default:  umask of the mounting process.
-
-  session=n
-       Select the CDROM session to mount as HFSPlus filesystem.  Defaults to
-       leaving that decision to the CDROM driver.  This option will fail
-       with anything but a CDROM as underlying devices.
-
-  part=n
-       Select partition number n from the devices.  This option only makes
-       sense for CDROMs because they can't be partitioned under Linux.
-       For disk devices the generic partition parsing code does this
-       for us.  Defaults to not parsing the partition table at all.
-
-  decompose
-       Decompose file name characters.
-
-  nodecompose
-       Do not decompose file name characters.
-
-  force
-       Used to force write access to volumes that are marked as journalled
-       or locked.  Use at your own risk.
-
-  nls=cccc
-       Encoding to use when presenting file names.
-
-
-References
-==========
-
-kernel source:         <file:fs/hfsplus>
-
-Apple Technote 1150    https://developer.apple.com/legacy/library/technotes/tn/tn1150.html
index c16e517..c351bc8 100644 (file)
@@ -67,6 +67,7 @@ Documentation for filesystem implementations.
    f2fs
    gfs2
    gfs2-uevents
+   hfsplus
    fuse
    overlayfs
    virtiofs