Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific'

Changbin Du
2019-10-16T00:10:45Z

On Tue, Oct 15, 2019 at 12:27:26PM -0600, Jonathan Corbet wrote:
> On Sun, 13 Oct 2019 13:53:59 +0800
> Changbin Du <changbin.du@gmail.com> wrote:
>
> > The 'functions' directive is not only for functions, but also works for
> > structs/unions. So the name is misleading. This patch renames it to
> > 'specific', so now we have export/internal/specific directives to limit
> > the functions/types to be included in documentation. Meanwhile we improved
> > the warning message.
>
> I agree with the others that "specific" doesn't really make things
> better. "Interfaces" maybe; otherwise we could go for something like
> "filter" or "select".
>
Jonathan, How about 'identifier' suggested by Matthew as it is mentioned in Then
C spec?

> Paint mine green :)
>
> Whatever we end up with, I think it should be added as a synonym for
> "functions". Then the various selectors that are actually pulling out
> docs for functions could be changed at leisure - or not at all. I'd
> rather not see a big patch changing everything at once.
>
Sure, I'll make 'functions' deprecated and as an alias to our new directive name.

> Thanks,
>
> jon

--
Cheers,
Changbin Du