| Message ID | 20200821190159.1033740-5-masahiroy@kernel.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | kbuild: clang-tidy | expand |
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 >
On Sat, Aug 22, 2020 at 9:29 AM 'Nick Desaulniers' via Clang Built Linux <clang-built-linux@googlegroups.com> wrote: > > 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 `.`). Will fix. > > 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) The help message of -h starts with a lower case. The others start with a capital letter. It would be better if "show this help message and exit" started with a capital letter. But, it comes from the library, so I do not know how to change it. I changed our code to make it consistent, but starting them with a capital letter is a preferred style, I can do as you suggest. Currently, the help looks like follows: ---------------->8----------------------- masahiro@oscar:~/ref/linux$ ./scripts/gen_compile_commands.py -h usage: gen_compile_commands.py [-h] [-d DIRECTORY] [-o OUTPUT] [--log_level LOG_LEVEL] Creates a compile_commands.json database from kernel .cmd files optional arguments: -h, --help show this help message and exit -d DIRECTORY, --directory DIRECTORY Path to the kernel source directory to search (defaults to the working directory) -o OUTPUT, --output OUTPUT The location to write compile_commands.json (defaults to compile_commands.json in the search directory) --log_level LOG_LEVEL The level of log messages to produce (one of DEBUG, INFO, WARNING, ERROR, CRITICAL; defaults to WARNING) ---------------->8----------------------- Thanks.
On Fri, Aug 21, 2020 at 6:56 PM Masahiro Yamada <masahiroy@kernel.org> wrote: > > On Sat, Aug 22, 2020 at 9:29 AM 'Nick Desaulniers' via Clang Built > Linux <clang-built-linux@googlegroups.com> wrote: > > > > 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 `.`). > > Will fix. > > > > > 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) > > > > > The help message of -h starts with a lower case. > The others start with a capital letter. > > It would be better if "show this help message and exit" > started with a capital letter. But, it comes from the > library, so I do not know how to change it. > > I changed our code to make it consistent, but > starting them with a capital letter is a preferred style, > I can do as you suggest. Consistency throughout the patch is my priority, not necessarily whether we're using Capitalization or not. > > > Currently, the help looks like follows: > > ---------------->8----------------------- > masahiro@oscar:~/ref/linux$ ./scripts/gen_compile_commands.py -h > usage: gen_compile_commands.py [-h] [-d DIRECTORY] [-o OUTPUT] > [--log_level LOG_LEVEL] > > Creates a compile_commands.json database from kernel .cmd files > > optional arguments: > -h, --help show this help message and exit > -d DIRECTORY, --directory DIRECTORY > Path to the kernel source directory to search > (defaults to the working directory) > -o OUTPUT, --output OUTPUT > The location to write compile_commands.json > (defaults to compile_commands.json in the search > directory) > --log_level LOG_LEVEL > The level of log messages to produce (one of > DEBUG, INFO, WARNING, ERROR, CRITICAL; defaults to > WARNING) > ---------------->8----------------------- > > > > Thanks. > > > -- > Best Regards > Masahiro Yamada
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 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 ' '(defaults to the working directory)') parser.add_argument('-d', '--directory', type=str, help=directory_help)
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(-)