linux-kernel - Re: [PATCH 14/34] docs: filesystems: convert dnotify.txt to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200416084537.GA23739@quack2.suse.cz>
Date:   Thu, 16 Apr 2020 10:45:37 +0200
From:   Jan Kara <jack@...e.cz>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Jan Kara <jack@...e.cz>, Amir Goldstein <amir73il@...il.com>,
        linux-fsdevel@...r.kernel.org
Subject: Re: [PATCH 14/34] docs: filesystems: convert dnotify.txt to ReST

On Wed 15-04-20 16:32:27, Mauro Carvalho Chehab wrote:
> - 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@...nel.org>

Looks good to me. I expect you merge this through documentation tree so you
can add:

Acked-by: Jan Kara <jack@...e.cz>

								Honza



> ---
>  .../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 <sfr@...b.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
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 470b2da2b7b1..960e0cc29491 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -26,6 +26,7 @@ algorithms work.
>     directory-locking
>     dax
>     devpts
> +   dnotify
>  
>     automount-support
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 511d19bcfa1e..eebb55517709 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -4995,7 +4995,7 @@ M:	Jan Kara <jack@...e.cz>
>  R:	Amir Goldstein <amir73il@...il.com>
>  L:	linux-fsdevel@...r.kernel.org
>  S:	Maintained
> -F:	Documentation/filesystems/dnotify.txt
> +F:	Documentation/filesystems/dnotify.rst
>  F:	fs/notify/dnotify/
>  F:	include/linux/dnotify.h
>  
> -- 
> 2.25.2
> 
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR