linux-kernel - Re: [PATCH v2 08/29] docs: filesystems: convert configfs.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 for Android: free password hash cracker in your pocket

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

Message-ID: <31da15f2-7755-3e56-d05c-1e3f388e0933@bikeshed.quignogs.org.uk>
Date:   Fri, 24 Apr 2020 18:34:17 +0100
From:   Peter Lister <peter@...eshed.quignogs.org.uk>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Joel Becker <jlbec@...lplan.org>,
        Christoph Hellwig <hch@....de>, linux-usb@...r.kernel.org
Subject: Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to ReST


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