From b31763cff488344aaabbee99739774aea1636e27 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 27 Apr 2020 23:17:03 +0200 Subject: [PATCH] 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: Mauro Carvalho Chehab Acked-by: Jan Kara Link: https://lore.kernel.org/r/b39d6430d1c28438e833f01cb4597eff78703c75.1588021877.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet --- .../filesystems/{dnotify.txt => dnotify.rst} | 11 ++++++++--- Documentation/filesystems/index.rst | 1 + MAINTAINERS | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) rename Documentation/filesystems/{dnotify.txt => dnotify.rst} (90%) diff --git a/Documentation/filesystems/dnotify.txt b/Documentation/filesystems/dnotify.rst similarity index 90% rename from Documentation/filesystems/dnotify.txt rename to Documentation/filesystems/dnotify.rst index 08d575ece45d..a28a1f9ef79c 100644 --- a/Documentation/filesystems/dnotify.txt +++ b/Documentation/filesystems/dnotify.rst @@ -1,5 +1,8 @@ - Linux Directory Notification - ============================ +.. SPDX-License-Identifier: GPL-2.0 + +============================ +Linux Directory Notification +============================ Stephen Rothwell @@ -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 diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 43717f11d10b..815101241115 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -25,6 +25,7 @@ algorithms work. locking directory-locking devpts + dnotify automount-support diff --git a/MAINTAINERS b/MAINTAINERS index 7d2fda93f838..46ba68a07a8f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4996,7 +4996,7 @@ M: Jan Kara R: Amir Goldstein 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