gen_compile_commands: reword the help message of -d option
authorMasahiro Yamada <masahiroy@kernel.org>
Sat, 22 Aug 2020 14:56:12 +0000 (23:56 +0900)
committerMasahiro Yamada <masahiroy@kernel.org>
Wed, 26 Aug 2020 15:44:33 +0000 (00:44 +0900)
commit0a7d376d04a3c84b503f1efecde8f9d9a7430269
tree5aac2bcda7deefe5cbd01e814f80fd69adc1cf4a
parent6ca4c6d25949117dc5b4845612e290b6d89e70a8
gen_compile_commands: reword the help message of -d option

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>
Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>
scripts/gen_compile_commands.py