* [PATCH 00/44] Manually convert filesystem FS documents to ReST @ 2020-02-17 16:11 Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 26/44] docs: filesystems: convert nilfs2.txt " Mauro Carvalho Chehab ` (2 more replies) 0 siblings, 3 replies; 7+ messages in thread From: Mauro Carvalho Chehab @ 2020-02-17 16:11 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Latchesar Ionkov, Martin Brandenburg, Jan Kara, Dominique Martinet, Amir Goldstein, Bob Copeland, David Howells, Joseph Qi, linux-mtd, Tyler Hicks, linux-afs, Mike Marshall, Naohiro Aota, Christoph Hellwig, linux-nilfs, Andreas Gruenbacher, Sage Weil, Jonathan Corbet, Mauro Carvalho Chehab, Richard Weinberger, Mark Fasheh, Chris Mason, Ryusuke Konishi, cluster-devel, v9fs-developer 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 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ ^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 26/44] docs: filesystems: convert nilfs2.txt to ReST 2020-02-17 16:11 [PATCH 00/44] Manually convert filesystem FS documents to ReST Mauro Carvalho Chehab @ 2020-02-17 16:12 ` Mauro Carvalho Chehab 2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox 2020-03-02 21:13 ` Jonathan Corbet 2 siblings, 0 replies; 7+ messages in thread From: Mauro Carvalho Chehab @ 2020-02-17 16:12 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab, Jonathan Corbet, linux-fsdevel, Ryusuke Konishi, linux-nilfs - Add a SPDX header; - Add a document title; - Adjust document title; - Mark literal blocks as such; - use :field: markup; - Add table markups; - Add it to filesystems/index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- Documentation/filesystems/index.rst | 3 +- .../filesystems/{nilfs2.txt => nilfs2.rst} | 40 ++++++++++++------- 2 files changed, 27 insertions(+), 16 deletions(-) rename Documentation/filesystems/{nilfs2.txt => nilfs2.rst} (89%) diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 8c8813ada53f..01587704fcc9 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -70,9 +70,10 @@ Documentation for filesystem implementations. hfs hfsplus hpfs + fuse inotify isofs - fuse + nilfs2 overlayfs virtiofs vfat diff --git a/Documentation/filesystems/nilfs2.txt b/Documentation/filesystems/nilfs2.rst similarity index 89% rename from Documentation/filesystems/nilfs2.txt rename to Documentation/filesystems/nilfs2.rst index f2f3f8592a6f..6c49f04e9e0a 100644 --- a/Documentation/filesystems/nilfs2.txt +++ b/Documentation/filesystems/nilfs2.rst @@ -1,5 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0 + +====== NILFS2 ------- +====== NILFS2 is a log-structured file system (LFS) supporting continuous snapshotting. In addition to versioning capability of the entire file @@ -25,9 +28,9 @@ available from the following download page. At least "mkfs.nilfs2", cleaner or garbage collector) are required. Details on the tools are described in the man pages included in the package. -Project web page: https://nilfs.sourceforge.io/ -Download page: https://nilfs.sourceforge.io/en/download.html -List info: http://vger.kernel.org/vger-lists.html#linux-nilfs +:Project web page: https://nilfs.sourceforge.io/ +:Download page: https://nilfs.sourceforge.io/en/download.html +:List info: http://vger.kernel.org/vger-lists.html#linux-nilfs Caveats ======= @@ -47,6 +50,7 @@ Mount options NILFS2 supports the following mount options: (*) == default +======================= ======================================================= barrier(*) This enables/disables the use of write barriers. This nobarrier requires an IO stack which can support barriers, and if nilfs gets an error on a barrier write, it will @@ -79,6 +83,7 @@ discard This enables/disables the use of discard/TRIM commands. nodiscard(*) The discard/TRIM commands are sent to the underlying block device when blocks are freed. This is useful for SSD devices and sparse/thinly-provisioned LUNs. +======================= ======================================================= Ioctls ====== @@ -87,9 +92,11 @@ There is some NILFS2 specific functionality which can be accessed by application through the system call interfaces. The list of all NILFS2 specific ioctls are shown in the table below. -Table of NILFS2 specific ioctls -.............................................................................. +Table of NILFS2 specific ioctls: + + ============================== =============================================== Ioctl Description + ============================== =============================================== NILFS_IOCTL_CHANGE_CPMODE Change mode of given checkpoint between checkpoint and snapshot state. This ioctl is used in chcp and mkcp utilities. @@ -142,11 +149,12 @@ Table of NILFS2 specific ioctls NILFS_IOCTL_SET_ALLOC_RANGE Define lower limit of segments in bytes and upper limit of segments in bytes. This ioctl is used by nilfs_resize utility. + ============================== =============================================== NILFS2 usage ============ -To use nilfs2 as a local file system, simply: +To use nilfs2 as a local file system, simply:: # mkfs -t nilfs2 /dev/block_device # mount -t nilfs2 /dev/block_device /dir @@ -157,18 +165,20 @@ This will also invoke the cleaner through the mount helper program Checkpoints and snapshots are managed by the following commands. Their manpages are included in the nilfs-utils package above. + ==== =========================================================== lscp list checkpoints or snapshots. mkcp make a checkpoint or a snapshot. chcp change an existing checkpoint to a snapshot or vice versa. rmcp invalidate specified checkpoint(s). + ==== =========================================================== -To mount a snapshot, +To mount a snapshot:: # mount -t nilfs2 -r -o cp=<cno> /dev/block_device /snap_dir where <cno> is the checkpoint number of the snapshot. -To unmount the NILFS2 mount point or snapshot, simply: +To unmount the NILFS2 mount point or snapshot, simply:: # umount /dir @@ -181,7 +191,7 @@ Disk format A nilfs2 volume is equally divided into a number of segments except for the super block (SB) and segment #0. A segment is the container of logs. Each log is composed of summary information blocks, payload -blocks, and an optional super root block (SR): +blocks, and an optional super root block (SR):: ______________________________________________________ | |SB| | Segment | Segment | Segment | ... | Segment | | @@ -200,7 +210,7 @@ blocks, and an optional super root block (SR): |_blocks__|_________________|__| The payload blocks are organized per file, and each file consists of -data blocks and B-tree node blocks: +data blocks and B-tree node blocks:: |<--- File-A --->|<--- File-B --->| _______________________________________________________________ @@ -213,7 +223,7 @@ files without data blocks or B-tree node blocks. The organization of the blocks is recorded in the summary information blocks, which contains a header structure (nilfs_segment_summary), per -file structures (nilfs_finfo), and per block structures (nilfs_binfo): +file structures (nilfs_finfo), and per block structures (nilfs_binfo):: _________________________________________________________________________ | Summary | finfo | binfo | ... | binfo | finfo | binfo | ... | binfo |... @@ -223,7 +233,7 @@ file structures (nilfs_finfo), and per block structures (nilfs_binfo): The logs include regular files, directory files, symbolic link files and several meta data files. The mata data files are the files used to maintain file system meta data. The current version of NILFS2 uses -the following meta data files: +the following meta data files:: 1) Inode file (ifile) -- Stores on-disk inodes 2) Checkpoint file (cpfile) -- Stores checkpoints @@ -232,7 +242,7 @@ the following meta data files: (DAT) block numbers. This file serves to make on-disk blocks relocatable. -The following figure shows a typical organization of the logs: +The following figure shows a typical organization of the logs:: _________________________________________________________________________ | Summary | regular file | file | ... | ifile | cpfile | sufile | DAT |SR| @@ -250,7 +260,7 @@ three special inodes, inodes for the DAT, cpfile, and sufile. Inodes of regular files, directories, symlinks and other special files, are included in the ifile. The inode of ifile itself is included in the corresponding checkpoint entry in the cpfile. Thus, the hierarchy -among NILFS2 files can be depicted as follows: +among NILFS2 files can be depicted as follows:: Super block (SB) | -- 2.24.1 ^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH 00/44] Manually convert filesystem FS documents to ReST 2020-02-17 16:11 [PATCH 00/44] Manually convert filesystem FS documents to ReST Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 26/44] docs: filesystems: convert nilfs2.txt " Mauro Carvalho Chehab @ 2020-02-18 4:01 ` Matthew Wilcox 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-03-02 21:13 ` Jonathan Corbet 2 siblings, 1 reply; 7+ messages in thread From: Matthew Wilcox @ 2020-02-18 4:01 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Latchesar Ionkov, Martin Brandenburg, Jan Kara, Linux Doc Mailing List, Dominique Martinet, Amir Goldstein, Bob Copeland, David Howells, Chris Mason, linux-mtd, Ilya Dryomov, linux-afs, Mike Marshall, Naohiro Aota, Christoph Hellwig, linux-nilfs, Andreas Gruenbacher, Sage Weil, Jonathan Corbet, Richard Weinberger, Tyler Hicks, cluster-devel, v9fs-developer, Gao Xiang, linux-ext4, Salah 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? ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 00/44] Manually convert filesystem FS documents to ReST 2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox @ 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-02-19 9:32 ` Jonathan Corbet 0 siblings, 1 reply; 7+ messages in thread From: Mauro Carvalho Chehab @ 2020-02-18 10:04 UTC (permalink / raw) To: Matthew Wilcox Cc: Latchesar Ionkov, Martin Brandenburg, Jan Kara, Linux Doc Mailing List, Dominique Martinet, Amir Goldstein, Bob Copeland, David Howells, Chris Mason, linux-mtd, Ilya Dryomov, linux-afs, Mike Marshall, Naohiro Aota, Christoph Hellwig, linux-nilfs, Andreas Gruenbacher, Sage Weil, Jonathan Corbet, Richard Weinberger, Tyler Hicks, cluster-devel, v9fs-developer, Gao Xiang, linux-ext4, Salah Em Mon, 17 Feb 2020 20:01:46 -0800 Matthew Wilcox <willy@infradead.org> escreveu: > 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? It makes sense to me. Yet, there are some of those files that contains both user-facing and kernel-facing docs at the same place. Btw, I found the same pattern on *several* other subsystems: when someone is documenting some feature, it tends to document both kAPI, uAPI and admin. Right now, what we did so far on most places were to keep the stuff together, as splitting them could sometimes be painful. As we are too close to finish the ReST conversion[1], I would prefer to first finish it. Then, do a second pass at files outside the new directories (like admin-guide), in order to better organize things, eventually splitting some files into kAPI, uAPI and/or admin-guide. [1] Looking at next-20200217, after my last doc patches applied on this tree: https://git.linuxtv.org/mchehab/experimental.git/log/?h=all_docs_merged excluding (most) false positives, we have now only ~50 text files left to convert: $ dirname $(find Documentation/ -type f|grep -vE '\.(rst|svg|dot|py|awk|sh|pl|gitignore|S|yaml|c|inf|vim|modes)'|grep -vE '(Makefile|Kconfig|LICENSE|COPYING-logo|ChangeLog|CREDITS)'|grep -v devicetree/bindings|grep -vE 'Documentation/(ABI|features|output|SubmittingPatches|CodingStyle|logo.gif|dontdiff|sphinx/requirements.txt|admin-guide/kdump/gdbmacros.txt|admin-guide/aoe/udev.txt|EDID/hex|netlabel/draft-ietf-cipso-ipsecurity-01.txt|firmware_class/hotplug-script|target/target-export-device|networking/mac80211-auth-assoc-deauth.txt|sparc/oradax/dax-hv-api.txt)'|grep -v translations)|sort|uniq -c|sort -n $ echo -n "Total: " $ dirname $(find Documentation/ -type f|grep -vE '\.(rst|svg|dot|py|awk|sh|pl|gitignore|S|yaml|c|inf|vim|modes)'|grep -vE '(Makefile|Kconfig|LICENSE|COPYING-logo|ChangeLog|CREDITS)'|grep -v devicetree/bindings|grep -vE 'Documentation/(ABI|features|output|SubmittingPatches|CodingStyle|logo.gif|dontdiff|sphinx/requirements.txt|admin-guide/kdump/gdbmacros.txt|admin-guide/aoe/udev.txt|EDID/hex|netlabel/draft-ietf-cipso-ipsecurity-01.txt|firmware_class/hotplug-script|target/target-export-device|networking/mac80211-auth-assoc-deauth.txt|sparc/oradax/dax-hv-api.txt)'|grep -v translations)|wc -l 1 Documentation/filesystems/cifs 1 Documentation/filesystems/configfs 1 Documentation/scsi 1 Documentation/virt/kvm/devices 2 Documentation/admin-guide 3 Documentation 6 Documentation/devicetree 6 Documentation/filesystems/caching 8 Documentation/RCU 21 Documentation/filesystems Total: 50 Once we get this series merged, I'm planning to prepare and submit a second series doing the conversion for the other ~20 filesystem files. Btw, if you want to look how things will become after my patch series, I'm keeping a html build after all my patch series at: https://www.infradead.org/~mchehab/kernel_docs/ Cheers, Mauro ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 00/44] Manually convert filesystem FS documents to ReST 2020-02-18 10:04 ` Mauro Carvalho Chehab @ 2020-02-19 9:32 ` Jonathan Corbet 2020-02-19 15:11 ` Mauro Carvalho Chehab 0 siblings, 1 reply; 7+ messages in thread From: Jonathan Corbet @ 2020-02-19 9:32 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Latchesar Ionkov, Brandenburg, Jan Kara, Linux Doc Mailing List, Martinet, Amir Goldstein, Copeland, David Howells, Mason, linux-mtd, Dominique, Ilya Dryomov, linux-afs, Jan Kara, Mike Marshall, Aota, cluster-devel, linux-nilfs, Sage Weil, Richard Weinberger, Matthew Wilcox, Tyler Hicks, Naohiro, v9fs-developer, Gao Xiang, linux-ext4, Salah Triki, Alexey Dobriyan On Tue, 18 Feb 2020 11:04:06 +0100 Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > Then, do a second pass at files outside the new directories (like > admin-guide), in order to better organize things, eventually splitting > some files into kAPI, uAPI and/or admin-guide. I'm looking forward to this phase! Yes it is harder, and it often requires selling the idea to skeptical maintainers. But that is how, IMO, we get from where we're at now to something closer to a set of coherent kernel docs. Thanks, jon ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 00/44] Manually convert filesystem FS documents to ReST 2020-02-19 9:32 ` Jonathan Corbet @ 2020-02-19 15:11 ` Mauro Carvalho Chehab 0 siblings, 0 replies; 7+ messages in thread From: Mauro Carvalho Chehab @ 2020-02-19 15:11 UTC (permalink / raw) To: Jonathan Corbet Cc: Latchesar Ionkov, Martin Brandenburg, Jan Kara, Linux Doc Mailing List, Dominique Martinet, Amir Goldstein, Bob Copeland, David Howells, Chris Mason, linux-mtd, Ilya Dryomov, linux-afs, Mike Marshall, Naohiro Aota, Christoph Hellwig, linux-nilfs, Andreas Gruenbacher, Sage Weil, Richard Weinberger, Matthew Wilcox, Tyler Hicks, cluster-devel, v9fs-developer, Gao Xiang, linux-ext4, Salah Em Wed, 19 Feb 2020 02:32:34 -0700 Jonathan Corbet <corbet@lwn.net> escreveu: > On Tue, 18 Feb 2020 11:04:06 +0100 > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > > Then, do a second pass at files outside the new directories (like > > admin-guide), in order to better organize things, eventually splitting > > some files into kAPI, uAPI and/or admin-guide. > > I'm looking forward to this phase! Yes it is harder, and it often > requires selling the idea to skeptical maintainers. But that is how, > IMO, we get from where we're at now to something closer to a set of > coherent kernel docs. Yeah, fully agreed that this is an important step. I'm even more anxious for a third phase: filling the gaps. I'm pretty sure that several important parts of the Kernel aren't properly represented at Documentation. Yet, before start writing new things, we should first organizing what we already have, making them well-organized. Cheers, Mauro ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 00/44] Manually convert filesystem FS documents to ReST 2020-02-17 16:11 [PATCH 00/44] Manually convert filesystem FS documents to ReST Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 26/44] docs: filesystems: convert nilfs2.txt " Mauro Carvalho Chehab 2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox @ 2020-03-02 21:13 ` Jonathan Corbet 2 siblings, 0 replies; 7+ messages in thread From: Jonathan Corbet @ 2020-03-02 21:13 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Latchesar Ionkov, Martin Brandenburg, Jan Kara, Linux Doc Mailing List, Dominique Martinet, Amir Goldstein, Bob Copeland, David Howells, Joseph Qi, linux-mtd, Tyler Hicks, linux-afs, Mike Marshall, Naohiro Aota, Christoph Hellwig, linux-nilfs, Andreas Gruenbacher, Sage Weil, Richard Weinberger, Mark Fasheh, Chris Mason, Ryusuke Konishi, cluster-devel, v9fs-developer, Gao Xiang On Mon, 17 Feb 2020 17:11:46 +0100 Mauro Carvalho Chehab <mchehab+huawei@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 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ ^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2020-03-02 21:13 UTC | newest] Thread overview: 7+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2020-02-17 16:11 [PATCH 00/44] Manually convert filesystem FS documents to ReST Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 26/44] docs: filesystems: convert nilfs2.txt " Mauro Carvalho Chehab 2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-02-19 9:32 ` Jonathan Corbet 2020-02-19 15:11 ` Mauro Carvalho Chehab 2020-03-02 21:13 ` Jonathan Corbet
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).