Messages in this thread | ![/](/images/icornerl.gif) | | From | Nick Desaulniers <> | Date | Fri, 21 Aug 2020 17:29:23 -0700 | Subject | Re: [PATCH v2 4/9] gen_compile_commands: reword the help message of -d option |
| |
On Fri, Aug 21, 2020 at 12:02 PM Masahiro Yamada <masahiroy@kernel.org> wrote: > > I think the help message of the -d option is somewhat misleading. > > Path to the kernel source directory to search (defaults to the working directory) > > The part "kernel source directory" is the source of the confusion. > Some people misunderstand as if this script did not support separate > output directories. > > Actually, this script also works for out-of-tree builds. You can > use the -d option to point to the object output directory, not to > the source directory. It should match to the O= option used in the > previous kernel build, and then appears in the "directory" field of > compile_commands.json. > > Reword the help message. > > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org> > --- > > Changes in v2: > - New patch > > scripts/gen_compile_commands.py | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/scripts/gen_compile_commands.py b/scripts/gen_compile_commands.py > index 1b9899892d99..5f6318da01a2 100755 > --- a/scripts/gen_compile_commands.py > +++ b/scripts/gen_compile_commands.py > @@ -31,13 +31,13 @@ def parse_arguments(): > > Returns: > log_level: A logging level to filter log output. > - directory: The directory to search for .cmd files. > + directory: The work directory where the objects were built
Punctuation (add a period `.`).
> output: Where to write the compile-commands JSON file. > """ > usage = 'Creates a compile_commands.json database from kernel .cmd files' > parser = argparse.ArgumentParser(description=usage) > > - directory_help = ('Path to the kernel source directory to search ' > + directory_help = ('specify the output directory used for the kernel build '
Capitalization (specify -> Specify)
With that: Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>
> '(defaults to the working directory)') > parser.add_argument('-d', '--directory', type=str, help=directory_help) > > -- > 2.25.1 >
-- Thanks, ~Nick Desaulniers
| ![\](/images/icornerr.gif) |