lkml.org 
[lkml]   [2019]   [Apr]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 3/4] kernel-doc: Rename -function to -symbol
On Mon, Apr 08, 2019 at 01:03:49PM +0300, Jani Nikula wrote:
> On Fri, 05 Apr 2019, Sean Christopherson <sean.j.christopherson@intel.com> wrote:
> > The -function option applies to all symbol types, not just functions.
> > Rename it and update its help text and comments to reflect reality.
> >
> > Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
> > ---
> > Documentation/sphinx/kerneldoc.py | 4 ++--
> > scripts/kernel-doc | 8 ++++----
> > 2 files changed, 6 insertions(+), 6 deletions(-)
> >
> > diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
> > index 9d0a7f08f93b..c52b6caac356 100644
> > --- a/Documentation/sphinx/kerneldoc.py
> > +++ b/Documentation/sphinx/kerneldoc.py
> > @@ -73,12 +73,12 @@ class KernelDocDirective(Directive):
> > cmd += ['-internal']
> > export_file_patterns = str(self.options.get('internal')).split()
> > elif 'doc' in self.options:
> > - cmd += ['-function', str(self.options.get('doc'))]
> > + cmd += ['-symbol', str(self.options.get('doc'))]
> > elif 'functions' in self.options:
> > functions = self.options.get('functions').split()
> > if functions:
> > for f in functions:
> > - cmd += ['-function', f]
> > + cmd += ['-symbol', f]
> > else:
> > cmd += ['-no-doc-sections']
> >
> > diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> > index 9190110b9802..60ef90222a51 100755
> > --- a/scripts/kernel-doc
> > +++ b/scripts/kernel-doc
> > @@ -63,10 +63,10 @@ Output selection (mutually exclusive):
> > -internal Only output documentation for symbols that have NOT been
> > exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
> > in any input FILE or -export-file FILE.
> > - -function NAME Only output documentation for the given function(s)
> > - or DOC: section title(s). All other functions and DOC:
> > + -symbols NAME Only output documentation for the given symbol(s)
> > + or DOC: section title(s). All other symbols and DOC:
> > sections are ignored. May be specified multiple times.
> > - -nosymbol NAME Do NOT output documentation for the given symbol(s);
> > + -nosymbol NAME Do NOT output documentation for the given symbol(s);
> > only output documentation for the other symbols and
> > DOC: sections. May be specified multiple times.
>
> Please decide whether to use singular or prular, and stick to it
> throughout.

"-symbols NAME" is a typo, should be "-symbol NAME".


Any preference on keeping or removing the "(s)" in the description, e.g.

Only output documentation for the given function(s) or DOC: section title(s).

versus:

Only output documentation for the given symbol or DOC: section title.

I think it makes sense to drop the "(s)" as each option can only specify a
single symbole, i.e. the "(s)" behavior is covered by "May be specified
multiple times."

>
> BR,
> Jani.
>
>
> >
> > @@ -409,7 +409,7 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
> > $output_mode = "none";
> > } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
> > $modulename = shift @ARGV;
> > - } elsif ($cmd eq "function") { # to only output specific function
> > + } elsif ($cmd eq "symbol") { # to only output specific symbol
> > $output_selection = OUTPUT_INCLUDE;
> > $function = shift @ARGV;
> > $function_table{$function} = 1;
>
> --
> Jani Nikula, Intel Open Source Graphics Center

\
 
 \ /
  Last update: 2019-04-08 17:12    [W:0.066 / U:11.120 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site