Message ID | efc9e59925723e17d1a4741b11049616c221463e.1581955849.git.mchehab+huawei@kernel.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | Manually convert filesystem FS documents to ReST | expand |
On 20/2/18 00:11, Mauro Carvalho Chehab wrote: > - 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@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!J62vuPuajZiXibdGN7Xohrxt8XascTTzR2T7QluggF2lCXObu6HDN24MqEPApMb9-iEMmg$ > -Tools web page: https://urldefense.com/v3/__https://github.com/markfasheh/ocfs2-tools__;!!GqivPVa7Brio!J62vuPuajZiXibdGN7Xohrxt8XascTTzR2T7QluggF2lCXObu6HDN24MqEPApMb-Q-ssBg$ > -OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/ > +:Project web page: https://urldefense.com/v3/__http://ocfs2.wiki.kernel.org__;!!GqivPVa7Brio!J62vuPuajZiXibdGN7Xohrxt8XascTTzR2T7QluggF2lCXObu6HDN24MqEPApMb9-iEMmg$ > +:Tools web page: https://urldefense.com/v3/__https://github.com/markfasheh/ocfs2-tools__;!!GqivPVa7Brio!J62vuPuajZiXibdGN7Xohrxt8XascTTzR2T7QluggF2lCXObu6HDN24MqEPApMb-Q-ssBg$ > +: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@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 > ---------- ----------------- Better to remove the above line. > +============ =========================== > O_RDONLY Shared Read > O_RDWR Exclusive > +============ =========================== > > + > +============ =========================== > Open Flag Resulting Locking Behavior > ---------- -------------------------- Ditto. > +============ =========================== > 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 >
Em Tue, 18 Feb 2020 09:21:51 +0800 Joseph Qi <joseph.qi@linux.alibaba.com> escreveu: > On 20/2/18 00:11, Mauro Carvalho Chehab wrote: > > @@ -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 > > ---------- ----------------- > > Better to remove the above line. > > > +============ =========================== > > O_RDONLY Shared Read > > O_RDWR Exclusive > > +============ =========================== > > > > + > > +============ =========================== > > Open Flag Resulting Locking Behavior > > ---------- -------------------------- > > Ditto. Ok. So, I guess we can just merge the two tables into one, like: ============ ================= O_RDONLY Shared Read O_RDWR Exclusive O_NONBLOCK Trylock operation ============ ================= Right? Cheers, Mauro
On 20/2/18 18:07, Mauro Carvalho Chehab wrote: > Em Tue, 18 Feb 2020 09:21:51 +0800 > Joseph Qi <joseph.qi@linux.alibaba.com> escreveu: > >> On 20/2/18 00:11, Mauro Carvalho Chehab wrote: > >>> @@ -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 >>> ---------- ----------------- >> >> Better to remove the above line. >> >>> +============ =========================== >>> O_RDONLY Shared Read >>> O_RDWR Exclusive >>> +============ =========================== >>> >>> + >>> +============ =========================== >>> Open Flag Resulting Locking Behavior >>> ---------- -------------------------- >> >> Ditto. > > Ok. So, I guess we can just merge the two tables into one, like: > > ============ ================= > O_RDONLY Shared Read > O_RDWR Exclusive > O_NONBLOCK Trylock operation > ============ ================= > > Right? > I think they should be in different section. The first two are lock level, while the last is lock behavior. Thanks, Joseph
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@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
- 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@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%)