Received: by 2002:a25:1985:0:0:0:0:0 with SMTP id 127csp707889ybz; Wed, 15 Apr 2020 17:11:02 -0700 (PDT) X-Google-Smtp-Source: APiQypLWkJGcg9HrW2vg4J65b5Ju5/Gh+idotHeyoaX9t8k2FBfHseADbD4Bd2PolmvPGmwXv4Cx X-Received: by 2002:a50:eb08:: with SMTP id y8mr26435635edp.49.1586995862402; Wed, 15 Apr 2020 17:11:02 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1586995862; cv=none; d=google.com; s=arc-20160816; b=nFWP4xjIZqNrnw9k0hJFqlg1lFbHt5lzG3nOrZ03MtWIqFp0fbqCjQ2v72zAcjoqb0 o9DmNjPypA8N0+FmGhhw2RrqD7zjJATrF3I3ie2n5kVEZOa08YvKPHg109vNBnQcGrHM cT3WzHTXfBgiWhCm6Zte3QlVbCE95I6dkhnMgXG3sM0YQDuCzrgt3WumnxPO6OrneoBa JaQK9xsjZS503wKOO6b/47cC8fzT9/Gj0ZcDGy99vgf3JejLqdSTgfRAlXQNPn/pCOaA 6nJunrWYCkvhNUrMzYi9i9pctZOCgUfzxMhYghgwB5p+TVlaQsFP65dJmV16q7OOpjJR G1KA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=0nFeB4wxmbaeO6Voo+QL6GCdbJtq0paLz1TFjj4M4/g=; b=ucu71Iudzbu5BAQFd4mKnzCATh4AwhtFaJ0ReJkEsFWFPb6uS2Qc4ib22gZhRBYgsV m6CT1YX5QqQHyxc/m8kpOxHrktHgmss3sTB0lXam9NWjEQTxh+rlwiOx2TnVdU/swR1V 3Vd4nz2D9JMaZy1eVWsokxMGxFPiw05KDHbK5wMZAy3V6ICvCs7klm1jX4z2l/80w0gA ZlsxKk7d0HhAcjK3n8zGxTNmjcbYqDW122mDHv5t6OxzveTbyDlu+W0mtstpPoZel0Xs lQTjNJhF9SluJc6LTwSRscOCwOEmZ2KFcQmY6iJ3c+88/6TmXBNyrdSxZMYoWkud7zyQ GVcw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=aeA29pmr; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id cw10si8077051ejb.369.2020.04.15.17.10.39; Wed, 15 Apr 2020 17:11:02 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=aeA29pmr; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2392068AbgDOOoI (ORCPT + 99 others); Wed, 15 Apr 2020 10:44:08 -0400 Received: from mail.kernel.org ([198.145.29.99]:45452 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2392114AbgDOOc6 (ORCPT ); Wed, 15 Apr 2020 10:32:58 -0400 Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 2F5542173E; Wed, 15 Apr 2020 14:32:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586961171; bh=EaNKRyoKAmu0SYupy5gnfzNURPElXi66AZeWAzWbgA4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=aeA29pmrBhA7setJsjCWNOu3hQ2AUUvDkWGHWpK726j3D2Z3NgyX+NEZOPHmWGWF9 JxX7hgb2t7M1q2CRc+bIZlQ3+ZK0BQqz6eR439AyXB5HjCVZuXHLouEJnDMaSgWEmm nHLTclbxyo3jaqaogcfKsqlh6XvN4LjzUKyiiT+M= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOj5t-006kOo-FF; Wed, 15 Apr 2020 16:32:49 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Jan Kara , Amir Goldstein , linux-fsdevel@vger.kernel.org Subject: [PATCH 14/34] docs: filesystems: convert dnotify.txt to ReST Date: Wed, 15 Apr 2020 16:32:27 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org - 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 --- .../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 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 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 -- 2.25.2