]> www.infradead.org Git - users/dwmw2/linux.git/commitdiff
docs: filesystems: convert dnotify.txt to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 27 Apr 2020 21:17:03 +0000 (23:17 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 5 May 2020 15:22:22 +0000 (09:22 -0600)
- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Add table markups;
- Add it to filesystems/index.rst

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/b39d6430d1c28438e833f01cb4597eff78703c75.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/dnotify.rst [moved from Documentation/filesystems/dnotify.txt with 90% similarity]
Documentation/filesystems/index.rst
MAINTAINERS

similarity index 90%
rename from Documentation/filesystems/dnotify.txt
rename to Documentation/filesystems/dnotify.rst
index 08d575ece45d82355d88a2e35495ca630e56708d..a28a1f9ef79c05812b9d6e81f96e55cf74d1910d 100644 (file)
@@ -1,5 +1,8 @@
-               Linux Directory Notification
-               ============================
+.. SPDX-License-Identifier: GPL-2.0
+
+============================
+Linux Directory Notification
+============================
 
           Stephen Rothwell <sfr@canb.auug.org.au>
 
@@ -12,6 +15,7 @@ being delivered using signals.
 The application decides which "events" it wants to be notified about.
 The currently defined events are:
 
+       =========       =====================================================
        DN_ACCESS       A file in the directory was accessed (read)
        DN_MODIFY       A file in the directory was modified (write,truncate)
        DN_CREATE       A file was created in the directory
@@ -19,6 +23,7 @@ The currently defined events are:
        DN_RENAME       A file in the directory was renamed
        DN_ATTRIB       A file in the directory had its attributes
                        changed (chmod,chown)
+       =========       =====================================================
 
 Usually, the application must reregister after each notification, but
 if DN_MULTISHOT is or'ed with the event mask, then the registration will
@@ -36,7 +41,7 @@ especially important if DN_MULTISHOT is specified.  Note that SIGRTMIN
 is often blocked, so it is better to use (at least) SIGRTMIN + 1.
 
 Implementation expectations (features and bugs :-))
----------------------------
+---------------------------------------------------
 
 The notification should work for any local access to files even if the
 actual file system is on a remote server.  This implies that remote
index 43717f11d10bd5aa7c6709d71b16b166cb79e32e..81510124111512eb82fcd0e31e511b61813bfea8 100644 (file)
@@ -25,6 +25,7 @@ algorithms work.
    locking
    directory-locking
    devpts
+   dnotify
 
    automount-support
 
index 7d2fda93f8380e79b6976611828f3a5b2d540e46..46ba68a07a8f1a849e34fc278f89c15ee14c7faf 100644 (file)
@@ -4996,7 +4996,7 @@ M:        Jan Kara <jack@suse.cz>
 R:     Amir Goldstein <amir73il@gmail.com>
 L:     linux-fsdevel@vger.kernel.org
 S:     Maintained
-F:     Documentation/filesystems/dnotify.txt
+F:     Documentation/filesystems/dnotify.rst
 F:     fs/notify/dnotify/
 F:     include/linux/dnotify.h