[kvm-unit-tests,4/6] docs: mention checkpatch in the README

Message ID 20170111162841.15569-5-alex.bennee@linaro.org
State New
Headers show

Commit Message

Alex Bennée Jan. 11, 2017, 4:28 p.m.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 README.md | 1 +
 1 file changed, 1 insertion(+)

Comments

Paolo Bonzini Jan. 12, 2017, 12:29 p.m. | #1
On 11/01/2017 17:28, Alex Bennée wrote:
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  README.md | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/README.md b/README.md
> index 5027b62..9462824 100644
> --- a/README.md
> +++ b/README.md
> @@ -79,3 +79,4 @@ You can add the following to .git/config to do this automatically for you:
>      [format]
>          subjectprefix = kvm-unit-tests PATCH
>  
> +Please run the kernel's ./scripts/checkpatch.pl on new patches

Does it really work well on kvm-unit-tests?

Paolo
Alex Bennée Jan. 12, 2017, 12:35 p.m. | #2
Paolo Bonzini <pbonzini@redhat.com> writes:

> On 11/01/2017 17:28, Alex Bennée wrote:
>> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
>> ---
>>  README.md | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/README.md b/README.md
>> index 5027b62..9462824 100644
>> --- a/README.md
>> +++ b/README.md
>> @@ -79,3 +79,4 @@ You can add the following to .git/config to do this automatically for you:
>>      [format]
>>          subjectprefix = kvm-unit-tests PATCH
>>
>> +Please run the kernel's ./scripts/checkpatch.pl on new patches
>
> Does it really work well on kvm-unit-tests?

Well I keep getting pulled up on kernel coding style on my reviews so if
we mean it we should enforce it.

--
Alex Bennée
Andrew Jones Jan. 12, 2017, 5:08 p.m. | #3
On Thu, Jan 12, 2017 at 01:29:52PM +0100, Paolo Bonzini wrote:
> 

> 

> On 11/01/2017 17:28, Alex Bennée wrote:

> > Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

> > ---

> >  README.md | 1 +

> >  1 file changed, 1 insertion(+)

> > 

> > diff --git a/README.md b/README.md

> > index 5027b62..9462824 100644

> > --- a/README.md

> > +++ b/README.md

> > @@ -79,3 +79,4 @@ You can add the following to .git/config to do this automatically for you:

> >      [format]

> >          subjectprefix = kvm-unit-tests PATCH

> >  

> > +Please run the kernel's ./scripts/checkpatch.pl on new patches

> 

> Does it really work well on kvm-unit-tests?


I use it on new code (liberally ignoring stuff I don't think
is worth conforming to), but there's no chance it'll work on
old files (many lib files and pretty much all x86 files). So
we can't really enforce for x86 developers, as we prefer
consistency over kernel style. That said, I think mentioning
in the README that new files could use it (at least for guidance)
is a good idea.

Thanks,
drew

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Andrew Jones Jan. 12, 2017, 5:09 p.m. | #4
On Thu, Jan 12, 2017 at 12:35:03PM +0000, Alex Bennée wrote:
> 

> Paolo Bonzini <pbonzini@redhat.com> writes:

> 

> > On 11/01/2017 17:28, Alex Bennée wrote:

> >> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

> >> ---

> >>  README.md | 1 +

> >>  1 file changed, 1 insertion(+)

> >>

> >> diff --git a/README.md b/README.md

> >> index 5027b62..9462824 100644

> >> --- a/README.md

> >> +++ b/README.md

> >> @@ -79,3 +79,4 @@ You can add the following to .git/config to do this automatically for you:

> >>      [format]

> >>          subjectprefix = kvm-unit-tests PATCH

> >>

> >> +Please run the kernel's ./scripts/checkpatch.pl on new patches


s/patches/files

All patches should be new :-)

drew

> >

> > Does it really work well on kvm-unit-tests?

> 

> Well I keep getting pulled up on kernel coding style on my reviews so if

> we mean it we should enforce it.

> 

> --

> Alex Bennée

> --

> To unsubscribe from this list: send the line "unsubscribe kvm" in

> the body of a message to majordomo@vger.kernel.org

> More majordomo info at  http://vger.kernel.org/majordomo-info.html


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Patch hide | download patch | download mbox

diff --git a/README.md b/README.md
index 5027b62..9462824 100644
--- a/README.md
+++ b/README.md
@@ -79,3 +79,4 @@  You can add the following to .git/config to do this automatically for you:
     [format]
         subjectprefix = kvm-unit-tests PATCH
 
+Please run the kernel's ./scripts/checkpatch.pl on new patches