Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Thu, 20 Dec 2018 08:41:50 -0700
From:   Jonathan Corbet <corbet@lwn.net>
To:     Helen Koike <helen.koike@collabora.com>
Cc:     linux-doc@vger.kernel.org, kernel@collabora.com,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] configfs: fix wrong name of struct in documentation
Message-ID: <20181220084150.3075f8d7@lwn.net>
In-Reply-To: <20181207191158.18769-1-helen.koike@collabora.com>
References: <20181207191158.18769-1-helen.koike@collabora.com>
Organization: LWN.net
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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

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