[v2,4/8] doc: Remind authors and maintainers to run make check

Signed-off-by: Richard Palethorpe <rpalethorpe@suse.com>
---
 doc/maintainer-patch-review-checklist.txt | 2 +-
 doc/test-writing-guidelines.txt           | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

Hi Richie,

> Signed-off-by: Richard Palethorpe <rpalethorpe@suse.com>
> ---
>  doc/maintainer-patch-review-checklist.txt | 2 +-
>  doc/test-writing-guidelines.txt           | 1 +
>  2 files changed, 2 insertions(+), 1 deletion(-)

> diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/maintainer-patch-review-checklist.txt
> index f6682b574..970779acc 100644
> --- a/doc/maintainer-patch-review-checklist.txt
> +++ b/doc/maintainer-patch-review-checklist.txt
> @@ -39,7 +39,7 @@ New test should
>  * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
>  * Test binaries are added into corresponding '.gitignore' files
>  * Check coding style with
> -  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]
> +  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check`
>    (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
+1

"131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link
should be #21-c-coding-style.

Kind regards,
Petr

>  * Docparse documentation
>  * If a test is a regression test it should include tags
> diff --git a/doc/test-writing-guidelines.txt b/doc/test-writing-guidelines.txt
> index 74e8ad7ee..e3268852a 100644
> --- a/doc/test-writing-guidelines.txt
> +++ b/doc/test-writing-guidelines.txt
> @@ -308,6 +308,7 @@ NOTE: See also
>  3. The runtest entires are in place
>  4. Test binaries are added into corresponding '.gitignore' files
>  5. Patches apply over the latest git
> +6. 'make check' does not emit any warnings
+1

Kind regards,
Petr

Hello Petr,

Petr Vorel <pvorel@suse.cz> writes:

> Hi Richie,
>
>> Signed-off-by: Richard Palethorpe <rpalethorpe@suse.com>
>> ---
>>  doc/maintainer-patch-review-checklist.txt | 2 +-
>>  doc/test-writing-guidelines.txt           | 1 +
>>  2 files changed, 2 insertions(+), 1 deletion(-)
>
>> diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/maintainer-patch-review-checklist.txt
>> index f6682b574..970779acc 100644
>> --- a/doc/maintainer-patch-review-checklist.txt
>> +++ b/doc/maintainer-patch-review-checklist.txt
>> @@ -39,7 +39,7 @@ New test should
>>  * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
>>  * Test binaries are added into corresponding '.gitignore' files
>>  * Check coding style with
>> -  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]
>> +  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check`
>>    (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
> +1
>
> "131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link
> should be #21-c-coding-style.

You may want to do a quick-fix commit for that, because it is not part
of my patch. Although I can add it ofcourse.

>
> Kind regards,
> Petr
>
>>  * Docparse documentation
>>  * If a test is a regression test it should include tags
>> diff --git a/doc/test-writing-guidelines.txt b/doc/test-writing-guidelines.txt
>> index 74e8ad7ee..e3268852a 100644
>> --- a/doc/test-writing-guidelines.txt
>> +++ b/doc/test-writing-guidelines.txt
>> @@ -308,6 +308,7 @@ NOTE: See also
>>  3. The runtest entires are in place
>>  4. Test binaries are added into corresponding '.gitignore' files
>>  5. Patches apply over the latest git
>> +6. 'make check' does not emit any warnings
> +1
>
> Kind regards,
> Petr

> Hello Petr,

> Petr Vorel <pvorel@suse.cz> writes:

> > Hi Richie,

> >> Signed-off-by: Richard Palethorpe <rpalethorpe@suse.com>
> >> ---
> >>  doc/maintainer-patch-review-checklist.txt | 2 +-
> >>  doc/test-writing-guidelines.txt           | 1 +
> >>  2 files changed, 2 insertions(+), 1 deletion(-)

> >> diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/maintainer-patch-review-checklist.txt
> >> index f6682b574..970779acc 100644
> >> --- a/doc/maintainer-patch-review-checklist.txt
> >> +++ b/doc/maintainer-patch-review-checklist.txt
> >> @@ -39,7 +39,7 @@ New test should
> >>  * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
> >>  * Test binaries are added into corresponding '.gitignore' files
> >>  * Check coding style with
> >> -  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]
> >> +  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check`
> >>    (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
> > +1

> > "131" would mean section 1.3.1. If you put it into "2.1 C coding style" the link
> > should be #21-c-coding-style.

> You may want to do a quick-fix commit for that, because it is not part
> of my patch. Although I can add it ofcourse.
I'm sorry, I overlooked that it does not have ^+. Thanks for info!

Kind regards,
Petr