linux-kernel - Re: [PATCH] configfs: fix wrong name of struct in documentation

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] [day] [month] [year] [list]

Message-ID: <20181220084150.3075f8d7@lwn.net>
Date:   Thu, 20 Dec 2018 08:41:50 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Helen Koike <helen.koike@...labora.com>
Cc:     linux-doc@...r.kernel.org, kernel@...labora.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] configfs: fix wrong name of struct in documentation

On Fri,  7 Dec 2018 17:11:58 -0200
Helen Koike <helen.koike@...labora.com> wrote:

> The name of the struct is configfs_bin_attribute instead of
> configfs_attribute
> 
> Signed-off-by: Helen Koike <helen.koike@...labora.com>
> 
> ---
> 
>  Documentation/filesystems/configfs/configfs.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/filesystems/configfs/configfs.txt b/Documentation/filesystems/configfs/configfs.txt
> index 3828e85345ae..16e606c11f40 100644
> --- a/Documentation/filesystems/configfs/configfs.txt
> +++ b/Documentation/filesystems/configfs/configfs.txt
> @@ -216,7 +216,7 @@ be called whenever userspace asks for a write(2) on the attribute.
>  
>  [struct configfs_bin_attribute]
>  
> -	struct configfs_attribute {
> +	struct configfs_bin_attribute {
>  		struct configfs_attribute	cb_attr;
>  		void				*cb_private;
>  		size_t				cb_max_size;

The document is clearly wrong, and this patch makes it better, so I've
applied it - thanks!

That said, the structure appears to have grown some fields that are not
reflected in the document; I suspect that there's much more in there that
is somewhat fictional at this point.  Hopefully somebody someday can help
to fix it up.

Thanks,

jon