kernel-doc (was Re: + lib-digsigc-kernel-doc-warning-fixes.patch added to -mm tree)

kernel-doc (was Re: + lib-digsigc-kernel-doc-warning-fixes.patch added to -mm tree)

[Alexey Dobriyan]

On Thu, May 22, 2014 at 10:28 PM,  <akpm@linux-foundation.org> wrote:
>   * digsig_verify() - digital signature verification with public key
>   * @keyring:   keyring to search key in
>   * @sig:       digital signature
> - * @sigen:     length of the signature
> + * @siglen:    length of the signature
>   * @data:      data
>   * @datalen:   length of the data

Does anyone use kernel-doc generated documentation?
I'm serious.

  Alexey

Re: kernel-doc (was Re: + lib-digsigc-kernel-doc-warning-fixes.patch added to -mm tree)

[Theodore Ts'o]

On Mon, May 26, 2014 at 04:27:04PM +0300, Alexey Dobriyan wrote:
> On Thu, May 22, 2014 at 10:28 PM,  <akpm@linux-foundation.org> wrote:
> >   * digsig_verify() - digital signature verification with public key
> >   * @keyring:   keyring to search key in
> >   * @sig:       digital signature
> > - * @sigen:     length of the signature
> > + * @siglen:    length of the signature
> >   * @data:      data
> >   * @datalen:   length of the data
> 
> Does anyone use kernel-doc generated documentation?
> I'm serious.

The kernel-doc generated documentation is available on the web, and I
suspect a number of people find it when they run Google Searches.

The danger of course is that they might get documentation which is out
of sync with the upstream kernel (or whatever kernel they are
developing against), but I know I've found it useful on occasion.

	   	     	   	     	   - Ted

Re: kernel-doc (was Re: + lib-digsigc-kernel-doc-warning-fixes.patch added to -mm tree)

[Alexey Dobriyan]

On Mon, May 26, 2014 at 5:02 PM, Theodore Ts'o <tytso@mit.edu> wrote:
> On Mon, May 26, 2014 at 04:27:04PM +0300, Alexey Dobriyan wrote:
>> On Thu, May 22, 2014 at 10:28 PM,  <akpm@linux-foundation.org> wrote:
>> >   * digsig_verify() - digital signature verification with public key
>> >   * @keyring:   keyring to search key in
>> >   * @sig:       digital signature
>> > - * @sigen:     length of the signature
>> > + * @siglen:    length of the signature
>> >   * @data:      data
>> >   * @datalen:   length of the data
>>
>> Does anyone use kernel-doc generated documentation?
>> I'm serious.
>
> The kernel-doc generated documentation is available on the web, and I
> suspect a number of people find it when they run Google Searches.
>
> The danger of course is that they might get documentation which is out
> of sync with the upstream kernel (or whatever kernel they are
> developing against), but I know I've found it useful on occasion.

Yeah, they are outdated like those sites hyperlinking old kernels,
polluting google searches.

The thing is largely redundant.

Just opened random file, random comment:

/**
 * finish_open - finish opening a file
 * @file: file pointer                   <====
 * @dentry: pointer to dentry      <====
 * @open: open callback
 * @opened: state of open
 *

int finish_open(struct file *file, struct dentry *dentry,
                int (*open)(struct inode *, struct file *),
                int *opened)