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

From: Jonathan Corbet
Date: Thu Dec 20 2018 - 10:41:54 EST


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

> The name of the struct is configfs_bin_attribute instead of
> configfs_attribute
>
> Signed-off-by: Helen Koike <helen.koike@xxxxxxxxxxxxx>
>
> ---
>
> 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