[PATCH v2] Documentation: Kunit: Use full path to .kunitconfig

[PATCH v2] Documentation: Kunit: Use full path to .kunitconfig

[Khalid Masum]

The fourth list item on writing test cases instructs adding Kconfig
fragments to .kunitconfig, which should have been full path to the file
(.kunit/.kunitconfig).

Cc: Sadiya Kazi <sadiyakazi@google.com>
Cc: David Gow <davidgow@google.com>
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
---
Changes since v1:
- Update commit message
- Make the instruction more descriptive

 Documentation/dev-tools/kunit/start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index 867a4bba6bf6..69361065cda6 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -217,7 +217,7 @@ Now we are ready to write the test cases.
 
 	obj-$(CONFIG_MISC_EXAMPLE_TEST) += example_test.o
 
-4. Add the following lines to ``.kunitconfig``:
+4. Add following configuration fragments to ``.kunit/.kunitconfig``:
 
 .. code-block:: none
 
-- 
2.37.3

Re: [PATCH v2] Documentation: Kunit: Use full path to .kunitconfig

[Bagas Sanjaya]

On 9/29/22 15:53, Khalid Masum wrote:
> The fourth list item on writing test cases instructs adding Kconfig
> fragments to .kunitconfig, which should have been full path to the file
> (.kunit/.kunitconfig).
> 
> Cc: Sadiya Kazi <sadiyakazi@google.com>
> Cc: David Gow <davidgow@google.com>
> Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
> ---
> Changes since v1:
> - Update commit message
> - Make the instruction more descriptive
> 
>  Documentation/dev-tools/kunit/start.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index 867a4bba6bf6..69361065cda6 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -217,7 +217,7 @@ Now we are ready to write the test cases.
>  
>  	obj-$(CONFIG_MISC_EXAMPLE_TEST) += example_test.o
>  
> -4. Add the following lines to ``.kunitconfig``:
> +4. Add following configuration fragments to ``.kunit/.kunitconfig``:
>  
>  .. code-block:: none
>  

Looks OK, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v2] Documentation: Kunit: Use full path to .kunitconfig

[David Gow]

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

On Thu, Sep 29, 2022 at 4:56 PM Khalid Masum <khalid.masum.92@gmail.com> wrote:
>
> The fourth list item on writing test cases instructs adding Kconfig
> fragments to .kunitconfig, which should have been full path to the file
> (.kunit/.kunitconfig).
>
> Cc: Sadiya Kazi <sadiyakazi@google.com>
> Cc: David Gow <davidgow@google.com>
> Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
> ---
> Changes since v1:
> - Update commit message
> - Make the instruction more descriptive
>

I confess, I think I prefer v1 overall here. Further notes below.

If there are no further objections, I'll continue to propose v1 for 6.1.

Cheers,
-- David


>  Documentation/dev-tools/kunit/start.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index 867a4bba6bf6..69361065cda6 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -217,7 +217,7 @@ Now we are ready to write the test cases.
>
>         obj-$(CONFIG_MISC_EXAMPLE_TEST) += example_test.o
>
> -4. Add the following lines to ``.kunitconfig``:
> +4. Add following configuration fragments to ``.kunit/.kunitconfig``:

At the risk of starting an argument, I actually preferred "the
following lines" here. "configuration fragments" doesn't quite
describe this perfectly, IMO. Maybe something like "config options"
would work better. Otherwise, just sticking with "lines" is probably
fine for the getting started guide. It's unlikely to confuse people,
and there's further discussion elsewhere in the documentation.

Regardless, we definitely should keep "the" here in "Add _the_
following". "Add following" is grammatically more dubious.

>
>  .. code-block:: none
>
> --
> 2.37.3
>

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