Commit b31763cf authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: filesystems: convert dnotify.txt to ReST 



- 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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarJan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/b39d6430d1c28438e833f01cb4597eff78703c75.1588021877.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 01478b83

Documentation/filesystems/dnotify.txt→Documentation/filesystems/dnotify.rst

+8 −3
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



============================

Linux Directory Notification

============================
@@ -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

Documentation/filesystems/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ algorithms work. 
   locking

   directory-locking

   devpts

   dnotify



   automount-support

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -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