* [PATCH 09/44] docs: filesystems: convert ceph.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:11 ` Mauro Carvalho Chehab
2020-02-18 11:57 ` Jeff Layton
2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox
2020-03-02 21:13 ` Jonathan Corbet
2 siblings, 1 reply; 8+ messages in thread
From: Mauro Carvalho Chehab @ 2020-02-17 16:11 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, linux-fsdevel,
Jeff Layton, Sage Weil, Ilya Dryomov, ceph-devel
- 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@kernel.org>
---
.../filesystems/{ceph.txt => ceph.rst} | 26 +++++++++++--------
Documentation/filesystems/index.rst | 1 +
2 files changed, 16 insertions(+), 11 deletions(-)
rename Documentation/filesystems/{ceph.txt => ceph.rst} (91%)
diff --git a/Documentation/filesystems/ceph.txt b/Documentation/filesystems/ceph.rst
similarity index 91%
rename from Documentation/filesystems/ceph.txt
rename to Documentation/filesystems/ceph.rst
index b19b6a03f91c..b46a7218248f 100644
--- a/Documentation/filesystems/ceph.txt
+++ b/Documentation/filesystems/ceph.rst
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============================
Ceph Distributed File System
============================
@@ -15,6 +18,7 @@ Basic features include:
* Easy deployment: most FS components are userspace daemons
Also,
+
* Flexible snapshots (on any directory)
* Recursive accounting (nested files, directories, bytes)
@@ -63,7 +67,7 @@ no 'du' or similar recursive scan of the file system is required.
Finally, Ceph also allows quotas to be set on any directory in the system.
The quota can restrict the number of bytes or the number of files stored
beneath that point in the directory hierarchy. Quotas can be set using
-extended attributes 'ceph.quota.max_files' and 'ceph.quota.max_bytes', eg:
+extended attributes 'ceph.quota.max_files' and 'ceph.quota.max_bytes', eg::
setfattr -n ceph.quota.max_bytes -v 100000000 /some/dir
getfattr -n ceph.quota.max_bytes /some/dir
@@ -76,7 +80,7 @@ from writing as much data as it needs.
Mount Syntax
============
-The basic mount syntax is:
+The basic mount syntax is::
# mount -t ceph monip[:port][,monip2[:port]...]:/[subdir] mnt
@@ -84,7 +88,7 @@ You only need to specify a single monitor, as the client will get the
full list when it connects. (However, if the monitor you specify
happens to be down, the mount won't succeed.) The port can be left
off if the monitor is using the default. So if the monitor is at
-1.2.3.4,
+1.2.3.4::
# mount -t ceph 1.2.3.4:/ /mnt/ceph
@@ -163,14 +167,14 @@ Mount Options
available modes are "no" and "clean". The default is "no".
* no: never attempt to reconnect when client detects that it has been
- blacklisted. Operations will generally fail after being blacklisted.
+ blacklisted. Operations will generally fail after being blacklisted.
* clean: client reconnects to the ceph cluster automatically when it
- detects that it has been blacklisted. During reconnect, client drops
- dirty data/metadata, invalidates page caches and writable file handles.
- After reconnect, file locks become stale because the MDS loses track
- of them. If an inode contains any stale file locks, read/write on the
- inode is not allowed until applications release all stale file locks.
+ detects that it has been blacklisted. During reconnect, client drops
+ dirty data/metadata, invalidates page caches and writable file handles.
+ After reconnect, file locks become stale because the MDS loses track
+ of them. If an inode contains any stale file locks, read/write on the
+ inode is not allowed until applications release all stale file locks.
More Information
================
@@ -179,8 +183,8 @@ For more information on Ceph, see the home page at
https://ceph.com/
The Linux kernel client source tree is available at
- https://github.com/ceph/ceph-client.git
- git://git.kernel.org/pub/scm/linux/kernel/git/sage/ceph-client.git
+ - https://github.com/ceph/ceph-client.git
+ - git://git.kernel.org/pub/scm/linux/kernel/git/sage/ceph-client.git
and the source for the full system is at
https://github.com/ceph/ceph.git
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index dae862cf167e..ddd8f7b2bb25 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -55,6 +55,7 @@ Documentation for filesystem implementations.
befs
bfs
btrfs
+ ceph
fuse
overlayfs
virtiofs
--
2.24.1
^ permalink raw reply related [flat|nested] 8+ messages in thread* Re: [PATCH 09/44] docs: filesystems: convert ceph.txt to ReST
2020-02-17 16:11 ` [PATCH 09/44] docs: filesystems: convert ceph.txt " Mauro Carvalho Chehab
@ 2020-02-18 11:57 ` Jeff Layton
0 siblings, 0 replies; 8+ messages in thread
From: Jeff Layton @ 2020-02-18 11:57 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Jonathan Corbet, linux-fsdevel, Sage Weil, Ilya Dryomov,
ceph-devel
On Mon, 2020-02-17 at 17:11 +0100, Mauro Carvalho Chehab wrote:
> - 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@kernel.org>
> ---
> .../filesystems/{ceph.txt => ceph.rst} | 26 +++++++++++--------
> Documentation/filesystems/index.rst | 1 +
> 2 files changed, 16 insertions(+), 11 deletions(-)
> rename Documentation/filesystems/{ceph.txt => ceph.rst} (91%)
>
Looks fine to me. Mauro, should I merge this via the ceph tree, or are
you merging them in via some other tree? In any case:
Acked-by: Jeff Layton <jlayton@kernel.org>
^ permalink raw reply [flat|nested] 8+ 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:11 ` [PATCH 09/44] docs: filesystems: convert ceph.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; 8+ 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] 8+ 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; 8+ 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] 8+ 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; 8+ 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] 8+ 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; 8+ 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] 8+ 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:11 ` [PATCH 09/44] docs: filesystems: convert ceph.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; 8+ 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] 8+ messages in thread