Re: [PATCH 1/3] Documentation: kunit: fix example run_kunit func to allow spaces in args

From: David Gow <davidgow@google.com>
To: Daniel Latypov <dlatypov@google.com>
Cc: Brendan Higgins <brendanhiggins@google.com>,
	Marco Elver <elver@google.com>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	kasan-dev <kasan-dev@googlegroups.com>,
	KUnit Development <kunit-dev@googlegroups.com>,
	"open list:KERNEL SELFTEST FRAMEWORK" 
	<linux-kselftest@vger.kernel.org>,
	Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH 1/3] Documentation: kunit: fix example run_kunit func to allow spaces in args
Date: Thu, 19 May 2022 21:20:03 +0800	[thread overview]
Message-ID: <CABVgOSnsZU1jnVbPuredPkDcxbJnq+1ojDU300yXV7jApj0=XQ@mail.gmail.com> (raw)
In-Reply-To: <20220518170124.2849497-2-dlatypov@google.com>

[-- Attachment #1: Type: text/plain, Size: 1236 bytes --]

On Thu, May 19, 2022 at 1:01 AM Daniel Latypov <dlatypov@google.com> wrote:
>
> Without the quoting, the example will mess up invocations like
> $ run_kunit "Something with spaces"
>
> Note: this example isn't valid, but if ever a usecase arises where a
> flag argument might have spaces in it, it'll break.
>
> Signed-off-by: Daniel Latypov <dlatypov@google.com>
> ---

Looks correct to me, though I'm not a bash _expert_.

Reviewed-by: David Gow <davidgow@google.com>

-- David

>  Documentation/dev-tools/kunit/running_tips.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kunit/running_tips.rst b/Documentation/dev-tools/kunit/running_tips.rst
> index c36f6760087d..da8677c32aee 100644
> --- a/Documentation/dev-tools/kunit/running_tips.rst
> +++ b/Documentation/dev-tools/kunit/running_tips.rst
> @@ -15,7 +15,7 @@ It can be handy to create a bash function like:
>  .. code-block:: bash
>
>         function run_kunit() {
> -         ( cd "$(git rev-parse --show-toplevel)" && ./tools/testing/kunit/kunit.py run $@ )
> +         ( cd "$(git rev-parse --show-toplevel)" && ./tools/testing/kunit/kunit.py run "$@" )
>         }
>
>  .. note::
> --
> 2.36.1.124.g0e6072fb45-goog
>

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4003 bytes --]