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

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

[Khalid Masum]

The numbered list contains full path to every files that need to be
modified or created in order to implement misc-example kunit test.
Except for .kunitconfig. Which might make a newcommer confused about
where the file exists. Since there are multiple .kunitconfig files.

Fix this by using the full path to .kunitconfig.

Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
---
 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 the following lines to ``.kunit/.kunitconfig``:
 
 .. code-block:: none
 
-- 
2.37.3

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

[David Gow]

+CC Sadiya

On Wed, Sep 28, 2022 at 12:01 PM Khalid Masum <khalid.masum.92@gmail.com> wrote:
>
> The numbered list contains full path to every files that need to be
> modified or created in order to implement misc-example kunit test.
> Except for .kunitconfig. Which might make a newcommer confused about

Nit: Spelling of "newcomer".

(I wouldn't bother sending out a new version just for this typo in the
commit description. If you need to do another version for another
reason, though, please fix it then.)

> where the file exists. Since there are multiple .kunitconfig files.
>
> Fix this by using the full path to .kunitconfig.
>
> Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
> ---

Thanks very much for your patch. This seems sensible to me.

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

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 the following lines to ``.kunit/.kunitconfig``:
>
>  .. code-block:: none
>
> --
> 2.37.3
>

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

[Bagas Sanjaya]

On 9/28/22 11:00, Khalid Masum wrote:
> The numbered list contains full path to every files that need to be
> modified or created in order to implement misc-example kunit test.
> Except for .kunitconfig. Which might make a newcommer confused about
> where the file exists. Since there are multiple .kunitconfig files.
> 
> Fix this by using the full path to .kunitconfig.
> 

Better say:

```
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).
```

> -4. Add the following lines to ``.kunitconfig``:
> +4. Add the following lines to ``.kunit/.kunitconfig``:
>  
>  .. code-block:: none
>  

I think "Add the following lines" should be changed to something more
descriptive in regards to what these lines are about (which in this
case should be "Add following configuration fragments").

Thanks.

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

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

[Khalid Masum]

Hi all,

Thanks for reviewing. I shall send a v2 with the suggested changes.

Thanks,
 -- Khalid Masum