From: Mauro Carvalho Chehab Date: Mon, 17 Feb 2020 16:12:08 +0000 (+0100) Subject: docs: filesystems: convert hfs.txt to ReST X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=5040a0acc8f2300ef35a1d9cc1c50a25235e061d;p=linux.git docs: filesystems: convert hfs.txt to ReST - Add a SPDX header; - Adjust document and section titles; - Use notes markups; - Add lists markups; - Add it to filesystems/index.rst. Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/8a625d6652d88809730020048d26c3b9333ddbdf.1581955849.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/filesystems/hfs.rst b/Documentation/filesystems/hfs.rst new file mode 100644 index 0000000000000..ab17a005e9b1e --- /dev/null +++ b/Documentation/filesystems/hfs.rst @@ -0,0 +1,87 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================== +Macintosh HFS Filesystem for Linux +================================== + + +.. Note:: This filesystem doesn't have a maintainer. + + +HFS stands for ``Hierarchical File System`` and is the filesystem used +by the Mac Plus and all later Macintosh models. Earlier Macintosh +models used MFS (``Macintosh File System``), which is not supported, +MacOS 8.1 and newer support a filesystem called HFS+ that's similar to +HFS but is extended in various areas. Use the hfsplus filesystem driver +to access such filesystems from Linux. + + +Mount options +============= + +When mounting an HFS 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 filesystems. + Default: user/group id of the mounting process. + + dir_umask=n, file_umask=n, umask=n + Specifies the umask used for all files , all directories or all + files and directories. Defaults to the umask of the mounting process. + + session=n + Select the CDROM session to mount as HFS 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. Does 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. + + quiet + Ignore invalid mount options instead of complaining. + + +Writing to HFS Filesystems +========================== + +HFS is not a UNIX filesystem, thus it does not have the usual features you'd +expect: + + * You can't modify the set-uid, set-gid, sticky or executable bits or the uid + and gid of files. + * You can't create hard- or symlinks, device files, sockets or FIFOs. + +HFS does on the other have the concepts of multiple forks per file. These +non-standard forks are represented as hidden additional files in the normal +filesystems namespace which is kind of a cludge and makes the semantics for +the a little strange: + + * You can't create, delete or rename resource forks of files or the + Finder's metadata. + * They are however created (with default values), deleted and renamed + along with the corresponding data fork or directory. + * Copying files to a different filesystem will loose those attributes + that are essential for MacOS to work. + + +Creating HFS filesystems +======================== + +The hfsutils package from Robert Leslie contains a program called +hformat that can be used to create HFS filesystem. See + for details. + + +Credits +======= + +The HFS drivers was written by Paul H. Hargrovea (hargrove@sccm.Stanford.EDU). +Roman Zippel (roman@ardistech.com) rewrote large parts of the code and brought +in btree routines derived from Brad Boyer's hfsplus driver. diff --git a/Documentation/filesystems/hfs.txt b/Documentation/filesystems/hfs.txt deleted file mode 100644 index d096df6db07af..0000000000000 --- a/Documentation/filesystems/hfs.txt +++ /dev/null @@ -1,82 +0,0 @@ -Note: This filesystem doesn't have a maintainer. - -Macintosh HFS Filesystem for Linux -================================== - -HFS stands for ``Hierarchical File System'' and is the filesystem used -by the Mac Plus and all later Macintosh models. Earlier Macintosh -models used MFS (``Macintosh File System''), which is not supported, -MacOS 8.1 and newer support a filesystem called HFS+ that's similar to -HFS but is extended in various areas. Use the hfsplus filesystem driver -to access such filesystems from Linux. - - -Mount options -============= - -When mounting an HFS 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 filesystems. - Default: user/group id of the mounting process. - - dir_umask=n, file_umask=n, umask=n - Specifies the umask used for all files , all directories or all - files and directories. Defaults to the umask of the mounting process. - - session=n - Select the CDROM session to mount as HFS 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. Does 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. - - quiet - Ignore invalid mount options instead of complaining. - - -Writing to HFS Filesystems -========================== - -HFS is not a UNIX filesystem, thus it does not have the usual features you'd -expect: - - o You can't modify the set-uid, set-gid, sticky or executable bits or the uid - and gid of files. - o You can't create hard- or symlinks, device files, sockets or FIFOs. - -HFS does on the other have the concepts of multiple forks per file. These -non-standard forks are represented as hidden additional files in the normal -filesystems namespace which is kind of a cludge and makes the semantics for -the a little strange: - - o You can't create, delete or rename resource forks of files or the - Finder's metadata. - o They are however created (with default values), deleted and renamed - along with the corresponding data fork or directory. - o Copying files to a different filesystem will loose those attributes - that are essential for MacOS to work. - - -Creating HFS filesystems -=================================== - -The hfsutils package from Robert Leslie contains a program called -hformat that can be used to create HFS filesystem. See - for details. - - -Credits -======= - -The HFS drivers was written by Paul H. Hargrovea (hargrove@sccm.Stanford.EDU). -Roman Zippel (roman@ardistech.com) rewrote large parts of the code and brought -in btree routines derived from Brad Boyer's hfsplus driver. diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index c351bc8a8c85a..f776411340cb5 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -67,6 +67,7 @@ Documentation for filesystem implementations. f2fs gfs2 gfs2-uevents + hfs hfsplus fuse overlayfs