Re: [PATCH] Documentation: Update filesystems/debugfs.txt

[Jonathan Corbet <corbet@lwn.net>]

On Thu, 16 Jul 2015 06:31:16 +0000
Wang Long <long.wanglong@huawei.com> wrote:

> This patch update the Documentation/filesystems/debugfs.txt
> file. The main work is to add the description of the following
> functions:
>     debugfs_create_atomic_t
>     debugfs_create_u32_array
>     debugfs_create_devm_seqfile
>     debugfs_create_file_size

I'll apply this because it's a definite improvement over what is there
now, but it would be nice to describe these functions a bit more in
detail.  In particular, a name like debugfs_create_devm_seqfile() will
cause at least some developers to think it will clean itself up when the
device goes away, but that does not appear to actually be the case...

>  Copyright 2009 Jonathan Corbet <corbet@lwn.net>
> +Updated by Wang Long <long.wanglong@huawei.com> on 2015/07/16

I think I'll drop that line, though; that's what the source code
management system is for.  Arguably the line it follows doesn't really
need to be there either...

Thanks,

jon