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;
Date:   Mon, 27 Apr 2020 23:02:58 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To:     Peter Lister <peter@bikeshed.quignogs.org.uk>
Cc:     Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        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
Subject: Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to
 ReST
Message-ID: <20200427230258.5f1cd909@coco.lan>
In-Reply-To: <31da15f2-7755-3e56-d05c-1e3f388e0933@bikeshed.quignogs.org.uk>
References: <cover.1587487612.git.mchehab+huawei@kernel.org>
        <278a9befc98b49ea866c9b687d070c70cde20628.1587487612.git.mchehab+huawei@kernel.org>
        <31da15f2-7755-3e56-d05c-1e3f388e0933@bikeshed.quignogs.org.uk>
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Em Fri, 24 Apr 2020 18:34:17 +0100
Peter Lister <peter@bikeshed.quignogs.org.uk> escreveu:

> > -configfs - Userspace-driven kernel object configuration.
> > +=======================================================
> > +Configfs - Userspace-driven Kernel oOject Configuration
> > +=======================================================  
> 
> Typo, presumably intended to be Object, not oOject?

Yeah, sorry for the typo.

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

This is to make things more uniform. The thing is: before the
ReST conversion, there were a mess of capitalization on titles.
Some documents all caps, others just the first letter, others
camel case and there were even some documents whose titles
were all lower case. Now, almost all documents are using the
same capitalization for titles.

> 
> > -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.

It is for consistency reasons. On all converted docs I touched, I used
the same convention for such markups: "Notes", "Important", "Warning"...

Thanks,
Mauro