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;
From:   Peter Lister <peter@bikeshed.quignogs.org.uk>
Subject: Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to ReST
To:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc:     linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Joel Becker <jlbec@evilplan.org>,
        Christoph Hellwig <hch@lst.de>, linux-usb@vger.kernel.org
References: <cover.1587487612.git.mchehab+huawei@kernel.org>
 <278a9befc98b49ea866c9b687d070c70cde20628.1587487612.git.mchehab+huawei@kernel.org>
Message-ID: <31da15f2-7755-3e56-d05c-1e3f388e0933@bikeshed.quignogs.org.uk>
Date:   Fri, 24 Apr 2020 18:34:17 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.7.0
MIME-Version: 1.0
In-Reply-To: <278a9befc98b49ea866c9b687d070c70cde20628.1587487612.git.mchehab+huawei@kernel.org>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-GB
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


> -configfs - Userspace-driven kernel object configuration.
> +=======================================================
> +Configfs - Userspace-driven Kernel oOject Configuration
> +=======================================================

Typo, presumably intended to be Object, not oOject?

Why amend capitalisation as part of converting to REST? Normal 
Linux/Unix convention is lower case for things like filesystems.

> -IMPORTANT: drop_item() is void, and as such cannot fail.  When rmdir(2)
> -is called, configfs WILL remove the item from the filesystem tree
> -(assuming that it has no children to keep it busy).  The subsystem is
> -responsible for responding to this.  If the subsystem has references to
> -the item in other threads, the memory is safe.  It may take some time
> -for the item to actually disappear from the subsystem's usage.  But it
> -is gone from configfs.
> +.. Important::
> +
> +   drop_item() is void, and as such cannot fail.  When rmdir(2)
> +   is called, configfs WILL remove the item from the filesystem tree
> +   (assuming that it has no children to keep it busy).  The subsystem is
> +   responsible for responding to this.  If the subsystem has references to
> +   the item in other threads, the memory is safe.  It may take some time
> +   for the item to actually disappear from the subsystem's usage.  But it
> +   is gone from configfs.

Using a  REST admonition is probably OK but, again, why change case?

The original author used shouting caps for IMPORTANT. A change can be 
argued for consistency or if there is an established preference for 
style. But, if so, that's a style patch, not a conversion.