Re: [PATCH 2/2] kunit: add tips to clean source tree to build help message

[Jonathan Corbet <corbet@lwn.net>]

Shuah Khan <skhan@linuxfoundation.org> writes:

> Add tips to clean source tree to build help message. When user run
> kunit.py after building another kernel for ARCH=foo, it is necessary
> to run 'make ARCH=foo mrproper' to remove all build artifacts generated
> during the build. In such cases, kunit build could fail.
>
> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
> ---
>  tools/testing/kunit/kunit.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py
> index 7f9ae55fd6d5..db86a396ed33 100755
> --- a/tools/testing/kunit/kunit.py
> +++ b/tools/testing/kunit/kunit.py
> @@ -583,7 +583,7 @@ def main(argv: Sequence[str]) -> None:
>  						'the options in .kunitconfig')
>  	add_common_opts(config_parser)
>  
> -	build_parser = subparser.add_parser('build', help='Builds a kernel with KUnit tests')
> +	build_parser = subparser.add_parser('build', help='Builds a kernel with KUnit tests. Successful build depends on a clean source tree. Run mrproper to clean generated artifcats for prior ARCH=foo kernel build. Run 'make ARCH=foo mrproper')
>  	add_common_opts(build_parser)

Nit: could perhaps that line be broken in a bit more readable way?

  	build_parser = subparser.add_parser('build',
        	help='Builds a kernel with KUnit tests. '
                  'Successful build depends on a clean source tree. '
                  'Run mrproper to clean generated artifacts for prior '
                  'ARCH=foo kernel build. '
                  'Run "make ARCH=foo mrproper"')

(fixed "artifacts" while I was in the neighborhood :)

jon