Mauro Carvalho Chehab
2020-Feb-17 16:11 UTC
[Ocfs2-devel] [PATCH 00/44] Manually convert filesystem FS documents to ReST
There are lots of plain text documents under Documentation/filesystems. Manually convert several of those to ReST and add them to the index file. Mauro Carvalho Chehab (44): docs: filesystems: convert 9p.txt to ReST docs: filesystems: convert adfs.txt to ReST docs: filesystems: convert affs.txt to ReST docs: filesystems: convert afs.txt to ReST docs: filesystems: convert autofs-mount-control.txt to ReST docs: filesystems: convert befs.txt to ReST docs: filesystems: convert bfs.txt to ReST docs: filesystems: convert btrfs.txt to ReST docs: filesystems: convert ceph.txt to ReST docs: filesystems: convert cramfs.txt to ReST docs: filesystems: convert debugfs.txt to ReST docs: filesystems: convert dlmfs.txt to ReST docs: filesystems: convert ecryptfs.txt to ReST docs: filesystems: convert efivarfs.txt to ReST docs: filesystems: convert erofs.txt to ReST docs: filesystems: convert ext2.txt to ReST docs: filesystems: convert ext3.txt to ReST docs: filesystems: convert f2fs.txt to ReST docs: filesystems: convert gfs2.txt to ReST docs: filesystems: convert gfs2-uevents.txt to ReST docs: filesystems: convert hfsplus.txt to ReST docs: filesystems: convert hfs.txt to ReST docs: filesystems: convert hpfs.txt to ReST docs: filesystems: convert inotify.txt to ReST docs: filesystems: convert isofs.txt to ReST docs: filesystems: convert nilfs2.txt to ReST docs: filesystems: convert ntfs.txt to ReST docs: filesystems: convert ocfs2-online-filecheck.txt to ReST docs: filesystems: convert ocfs2.txt to ReST docs: filesystems: convert omfs.txt to ReST docs: filesystems: convert orangefs.txt to ReST docs: filesystems: convert proc.txt to ReST docs: filesystems: convert qnx6.txt to ReST docs: filesystems: convert ramfs-rootfs-initramfs.txt to ReST docs: filesystems: convert relay.txt to ReST docs: filesystems: convert romfs.txt to ReST docs: filesystems: convert squashfs.txt to ReST docs: filesystems: convert sysfs.txt to ReST docs: filesystems: convert sysv-fs.txt to ReST docs: filesystems: convert tmpfs.txt to ReST docs: filesystems: convert ubifs-authentication.rst.txt to ReST docs: filesystems: convert ubifs.txt to ReST docs: filesystems: convert udf.txt to ReST docs: filesystems: convert zonefs.txt to ReST Documentation/filesystems/{9p.txt => 9p.rst} | 114 +- .../filesystems/{adfs.txt => adfs.rst} | 29 +- .../filesystems/{affs.txt => affs.rst} | 62 +- .../filesystems/{afs.txt => afs.rst} | 73 +- ...t-control.txt => autofs-mount-control.rst} | 102 +- .../filesystems/{befs.txt => befs.rst} | 59 +- .../filesystems/{bfs.txt => bfs.rst} | 37 +- .../filesystems/{btrfs.txt => btrfs.rst} | 3 + .../filesystems/{ceph.txt => ceph.rst} | 26 +- .../filesystems/{cramfs.txt => cramfs.rst} | 19 +- .../filesystems/{debugfs.txt => debugfs.rst} | 54 +- .../filesystems/{dlmfs.txt => dlmfs.rst} | 28 +- .../{ecryptfs.txt => ecryptfs.rst} | 44 +- .../{efivarfs.txt => efivarfs.rst} | 5 +- .../filesystems/{erofs.txt => erofs.rst} | 175 +- .../filesystems/{ext2.txt => ext2.rst} | 41 +- .../filesystems/{ext3.txt => ext3.rst} | 2 + .../filesystems/{f2fs.txt => f2fs.rst} | 252 +-- .../{gfs2-uevents.txt => gfs2-uevents.rst} | 20 +- .../filesystems/{gfs2.txt => gfs2.rst} | 20 +- .../filesystems/{hfs.txt => hfs.rst} | 23 +- .../filesystems/{hfsplus.txt => hfsplus.rst} | 2 + .../filesystems/{hpfs.txt => hpfs.rst} | 239 ++- Documentation/filesystems/index.rst | 46 +- .../filesystems/{inotify.txt => inotify.rst} | 33 +- Documentation/filesystems/isofs.rst | 64 + Documentation/filesystems/isofs.txt | 48 - .../filesystems/{nilfs2.txt => nilfs2.rst} | 40 +- .../filesystems/{ntfs.txt => ntfs.rst} | 143 +- ...lecheck.txt => ocfs2-online-filecheck.rst} | 45 +- .../filesystems/{ocfs2.txt => ocfs2.rst} | 31 +- Documentation/filesystems/omfs.rst | 112 ++ Documentation/filesystems/omfs.txt | 106 -- .../{orangefs.txt => orangefs.rst} | 187 +- .../filesystems/{proc.txt => proc.rst} | 1498 +++++++++-------- .../filesystems/{qnx6.txt => qnx6.rst} | 22 + ...itramfs.txt => ramfs-rootfs-initramfs.rst} | 54 +- .../filesystems/{relay.txt => relay.rst} | 129 +- .../filesystems/{romfs.txt => romfs.rst} | 42 +- .../{squashfs.txt => squashfs.rst} | 60 +- .../filesystems/{sysfs.txt => sysfs.rst} | 324 ++-- .../filesystems/{sysv-fs.txt => sysv-fs.rst} | 155 +- .../filesystems/{tmpfs.txt => tmpfs.rst} | 44 +- .../filesystems/ubifs-authentication.rst | 10 +- .../filesystems/{ubifs.txt => ubifs.rst} | 25 +- .../filesystems/{udf.txt => udf.rst} | 21 +- .../filesystems/{zonefs.txt => zonefs.rst} | 106 +- 47 files changed, 2739 insertions(+), 2035 deletions(-) rename Documentation/filesystems/{9p.txt => 9p.rst} (63%) rename Documentation/filesystems/{adfs.txt => adfs.rst} (85%) rename Documentation/filesystems/{affs.txt => affs.rst} (86%) rename Documentation/filesystems/{afs.txt => afs.rst} (90%) rename Documentation/filesystems/{autofs-mount-control.txt => autofs-mount-control.rst} (89%) rename Documentation/filesystems/{befs.txt => befs.rst} (83%) rename Documentation/filesystems/{bfs.txt => bfs.rst} (71%) rename Documentation/filesystems/{btrfs.txt => btrfs.rst} (96%) rename Documentation/filesystems/{ceph.txt => ceph.rst} (91%) rename Documentation/filesystems/{cramfs.txt => cramfs.rst} (88%) rename Documentation/filesystems/{debugfs.txt => debugfs.rst} (91%) rename Documentation/filesystems/{dlmfs.txt => dlmfs.rst} (86%) rename Documentation/filesystems/{ecryptfs.txt => ecryptfs.rst} (70%) rename Documentation/filesystems/{efivarfs.txt => efivarfs.rst} (85%) rename Documentation/filesystems/{erofs.txt => erofs.rst} (54%) rename Documentation/filesystems/{ext2.txt => ext2.rst} (91%) rename Documentation/filesystems/{ext3.txt => ext3.rst} (88%) rename Documentation/filesystems/{f2fs.txt => f2fs.rst} (84%) rename Documentation/filesystems/{gfs2-uevents.txt => gfs2-uevents.rst} (94%) rename Documentation/filesystems/{gfs2.txt => gfs2.rst} (76%) rename Documentation/filesystems/{hfs.txt => hfs.rst} (80%) rename Documentation/filesystems/{hfsplus.txt => hfsplus.rst} (95%) rename Documentation/filesystems/{hpfs.txt => hpfs.rst} (66%) rename Documentation/filesystems/{inotify.txt => inotify.rst} (83%) create mode 100644 Documentation/filesystems/isofs.rst delete mode 100644 Documentation/filesystems/isofs.txt rename Documentation/filesystems/{nilfs2.txt => nilfs2.rst} (89%) rename Documentation/filesystems/{ntfs.txt => ntfs.rst} (85%) rename Documentation/filesystems/{ocfs2-online-filecheck.txt => ocfs2-online-filecheck.rst} (77%) rename Documentation/filesystems/{ocfs2.txt => ocfs2.rst} (88%) create mode 100644 Documentation/filesystems/omfs.rst delete mode 100644 Documentation/filesystems/omfs.txt rename Documentation/filesystems/{orangefs.txt => orangefs.rst} (83%) rename Documentation/filesystems/{proc.txt => proc.rst} (65%) rename Documentation/filesystems/{qnx6.txt => qnx6.rst} (98%) rename Documentation/filesystems/{ramfs-rootfs-initramfs.txt => ramfs-rootfs-initramfs.rst} (91%) rename Documentation/filesystems/{relay.txt => relay.rst} (91%) rename Documentation/filesystems/{romfs.txt => romfs.rst} (86%) rename Documentation/filesystems/{squashfs.txt => squashfs.rst} (91%) rename Documentation/filesystems/{sysfs.txt => sysfs.rst} (56%) rename Documentation/filesystems/{sysv-fs.txt => sysv-fs.rst} (73%) rename Documentation/filesystems/{tmpfs.txt => tmpfs.rst} (86%) rename Documentation/filesystems/{ubifs.txt => ubifs.rst} (91%) rename Documentation/filesystems/{udf.txt => udf.rst} (83%) rename Documentation/filesystems/{zonefs.txt => zonefs.rst} (90%) -- 2.24.1
Mauro Carvalho Chehab
2020-Feb-17 16:11 UTC
[Ocfs2-devel] [PATCH 12/44] docs: filesystems: convert dlmfs.txt to ReST
- Add a SPDX header; - Use copyright symbol; - Adjust document title; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add table markups; - Add it to filesystems/index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei at kernel.org> --- .../filesystems/{dlmfs.txt => dlmfs.rst} | 28 +++++++++++++------ Documentation/filesystems/index.rst | 1 + 2 files changed, 20 insertions(+), 9 deletions(-) rename Documentation/filesystems/{dlmfs.txt => dlmfs.rst} (86%) diff --git a/Documentation/filesystems/dlmfs.txt b/Documentation/filesystems/dlmfs.rst similarity index 86% rename from Documentation/filesystems/dlmfs.txt rename to Documentation/filesystems/dlmfs.rst index fcf4d509d118..68daaa7facf9 100644 --- a/Documentation/filesystems/dlmfs.txt +++ b/Documentation/filesystems/dlmfs.rst @@ -1,20 +1,25 @@ -dlmfs -=================+.. SPDX-License-Identifier: GPL-2.0 +.. include:: <isonum.txt> + +====+DLMFS +====+ A minimal DLM userspace interface implemented via a virtual file system. dlmfs is built with OCFS2 as it requires most of its infrastructure. -Project web page: https://urldefense.com/v3/__http://ocfs2.wiki.kernel.org__;!!GqivPVa7Brio!M_za4-BJ-jyxvI9HpZr8m7YdCXlC2WssU4cPzlq8hlT8wrpBR8uenuTtz3lgLjxHzejs1A$ -Tools web page: https://urldefense.com/v3/__https://github.com/markfasheh/ocfs2-tools__;!!GqivPVa7Brio!M_za4-BJ-jyxvI9HpZr8m7YdCXlC2WssU4cPzlq8hlT8wrpBR8uenuTtz3lgLjyVQCxucQ$ -OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/ +:Project web page: https://urldefense.com/v3/__http://ocfs2.wiki.kernel.org__;!!GqivPVa7Brio!M_za4-BJ-jyxvI9HpZr8m7YdCXlC2WssU4cPzlq8hlT8wrpBR8uenuTtz3lgLjxHzejs1A$ +:Tools web page: https://urldefense.com/v3/__https://github.com/markfasheh/ocfs2-tools__;!!GqivPVa7Brio!M_za4-BJ-jyxvI9HpZr8m7YdCXlC2WssU4cPzlq8hlT8wrpBR8uenuTtz3lgLjyVQCxucQ$ +:OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/ All code copyright 2005 Oracle except when otherwise noted. -CREDITS +Credits ====== -Some code taken from ramfs which is Copyright (C) 2000 Linus Torvalds +Some code taken from ramfs which is Copyright |copy| 2000 Linus Torvalds and Transmeta Corp. Mark Fasheh <mark.fasheh at oracle.com> @@ -96,14 +101,19 @@ operation. If the lock succeeds, you'll get an fd. open(2) with O_CREAT to ensure the resource inode is created - dlmfs does not automatically create inodes for existing lock resources. +============ ========================== Open Flag Lock Request Type ---------- ----------------- +============ ========================== O_RDONLY Shared Read O_RDWR Exclusive +============ ========================== + +============ ========================== Open Flag Resulting Locking Behavior ---------- -------------------------- +============ ========================== O_NONBLOCK Trylock operation +============ ========================== You must provide exactly one of O_RDONLY or O_RDWR. diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index ab3b656bbe60..c6885c7ef781 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -58,6 +58,7 @@ Documentation for filesystem implementations. ceph cramfs debugfs + dlmfs fuse overlayfs virtiofs -- 2.24.1
Mauro Carvalho Chehab
2020-Feb-17 16:12 UTC
[Ocfs2-devel] [PATCH 29/44] docs: filesystems: convert ocfs2.txt to ReST
- Add a SPDX header; - Adjust document title; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add it to filesystems/index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei at kernel.org> --- Documentation/filesystems/index.rst | 1 + .../filesystems/{ocfs2.txt => ocfs2.rst} | 31 +++++++++++++------ 2 files changed, 22 insertions(+), 10 deletions(-) rename Documentation/filesystems/{ocfs2.txt => ocfs2.rst} (88%) diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index f3a26fdbd04f..3b2b07491c98 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -76,6 +76,7 @@ Documentation for filesystem implementations. nilfs2 nfs/index ntfs + ocfs2 ocfs2-online-filecheck overlayfs virtiofs diff --git a/Documentation/filesystems/ocfs2.txt b/Documentation/filesystems/ocfs2.rst similarity index 88% rename from Documentation/filesystems/ocfs2.txt rename to Documentation/filesystems/ocfs2.rst index 4c49e5410595..412386bc6506 100644 --- a/Documentation/filesystems/ocfs2.txt +++ b/Documentation/filesystems/ocfs2.rst @@ -1,5 +1,9 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=============== OCFS2 filesystem -=================+===============+ OCFS2 is a general purpose extent based shared disk cluster file system with many similarities to ext3. It supports 64 bit inode numbers, and has automatically extending metadata groups which may @@ -14,22 +18,26 @@ OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/ All code copyright 2005 Oracle except when otherwise noted. -CREDITS: +Credits +======+ Lots of code taken from ext3 and other projects. Authors in alphabetical order: -Joel Becker <joel.becker at oracle.com> -Zach Brown <zach.brown at oracle.com> -Mark Fasheh <mfasheh at suse.com> -Kurt Hackel <kurt.hackel at oracle.com> -Tao Ma <tao.ma at oracle.com> -Sunil Mushran <sunil.mushran at oracle.com> -Manish Singh <manish.singh at oracle.com> -Tiger Yang <tiger.yang at oracle.com> + +- Joel Becker <joel.becker at oracle.com> +- Zach Brown <zach.brown at oracle.com> +- Mark Fasheh <mfasheh at suse.com> +- Kurt Hackel <kurt.hackel at oracle.com> +- Tao Ma <tao.ma at oracle.com> +- Sunil Mushran <sunil.mushran at oracle.com> +- Manish Singh <manish.singh at oracle.com> +- Tiger Yang <tiger.yang at oracle.com> Caveats ====== Features which OCFS2 does not support yet: + - Directory change notification (F_NOTIFY) - Distributed Caching (F_SETLEASE/F_GETLEASE/break_lease) @@ -37,8 +45,10 @@ Mount options ============ OCFS2 supports the following mount options: + (*) == default +======================= ======================================================= barrier=1 This enables/disables barriers. barrier=0 disables it, barrier=1 enables it. errors=remount-ro(*) Remount the filesystem read-only on an error. @@ -104,3 +114,4 @@ journal_async_commit Commit block can be written to disk without waiting for descriptor blocks. If enabled older kernels cannot mount the device. This will enable 'journal_checksum' internally. +======================= =======================================================-- 2.24.1
Matthew Wilcox
2020-Feb-18 04:01 UTC
[Ocfs2-devel] [PATCH 00/44] Manually convert filesystem FS documents to ReST
On Mon, Feb 17, 2020 at 05:11:46PM +0100, Mauro Carvalho Chehab wrote:> There are lots of plain text documents under Documentation/filesystems. > > Manually convert several of those to ReST and add them to the index file.I think at least 90% of this material needs to be in admin-guide. Should we create Documentation/admin-guide/filesystems/ and move most of these files there?
Jonathan Corbet
2020-Mar-02 21:13 UTC
[Ocfs2-devel] [PATCH 00/44] Manually convert filesystem FS documents to ReST
On Mon, 17 Feb 2020 17:11:46 +0100 Mauro Carvalho Chehab <mchehab+huawei at kernel.org> wrote:> There are lots of plain text documents under Documentation/filesystems. > > Manually convert several of those to ReST and add them to the index file.OK, I've finally managed to add all the acks and wrestle this pile into docs-next - thanks. jon