linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] configfs: fix wrong name of struct in documentation
@ 2018-12-07 19:11 Helen Koike
  2018-12-20 15:41 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Helen Koike @ 2018-12-07 19:11 UTC (permalink / raw)
  To: linux-doc; +Cc: kernel, linux-kernel, corbet

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;
-- 
2.19.1


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] configfs: fix wrong name of struct in documentation
  2018-12-07 19:11 [PATCH] configfs: fix wrong name of struct in documentation Helen Koike
@ 2018-12-20 15:41 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2018-12-20 15:41 UTC (permalink / raw)
  To: Helen Koike; +Cc: linux-doc, kernel, linux-kernel

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2018-12-20 15:41 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-12-07 19:11 [PATCH] configfs: fix wrong name of struct in documentation Helen Koike
2018-12-20 15:41 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).