diff mbox

[kvm-unit-tests,v2,3/5] docs: mention checkpatch in the README

Message ID 20170117155424.19851-4-alex.bennee@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

Alex Bennée Jan. 17, 2017, 3:54 p.m. UTC
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 README.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

Comments

Andrew Jones Jan. 17, 2017, 5 p.m. UTC | #1
On Tue, Jan 17, 2017 at 03:54:22PM +0000, Alex Bennée wrote:
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>  README.md | 15 +++++++++------
>  1 file changed, 9 insertions(+), 6 deletions(-)
> 
> diff --git a/README.md b/README.md
> index b6f011d..c052dff 100644
> --- a/README.md
> +++ b/README.md
> @@ -79,9 +79,12 @@ You can add the following to .git/config to do this automatically for you:
>      [format]
>          subjectprefix = kvm-unit-tests PATCH
>  
> -Additionally it's helpful to have a common order of file types in patches.
> -Our chosen order attempts to place the more declarative files before
> -the code files. We also start with common code and finish with unit test
> -code. git-diff's orderFile feature allows us to specify the order in a
> -file. The orderFile we use is `scripts/git.difforder`. Adding the config
> -with `git config diff.orderFile scripts/git.difforder` enables it.
> +Additionally it is helpful to have a common order of file types in
> +patches. Our chosen order attempts to place the more declarative files
> +before the code files. We also start with common code and finish with
> +unit test code. git-diff's orderFile feature allows us to specify the
> +order in a file. The orderFile we use is `scripts/git.difforder`.
> +Adding the config with `git config diff.orderFile
> +scripts/git.difforder` enables it.

Why change the line length of all the above lines?

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

I'd extend this with something like

 , as we use the kernel's coding style. Note, not all kernel checks
 apply, so a 100% error free check is not required.

Thanks,
drew

> -- 
> 2.11.0
> 
--
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
Andrew Jones Jan. 17, 2017, 5:15 p.m. UTC | #2
On Tue, Jan 17, 2017 at 06:00:41PM +0100, Andrew Jones wrote:
> On Tue, Jan 17, 2017 at 03:54:22PM +0000, Alex Bennée wrote:
> > Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> > ---
> >  README.md | 15 +++++++++------
> >  1 file changed, 9 insertions(+), 6 deletions(-)
> > 
> > diff --git a/README.md b/README.md
> > index b6f011d..c052dff 100644
> > --- a/README.md
> > +++ b/README.md
> > @@ -79,9 +79,12 @@ You can add the following to .git/config to do this automatically for you:
> >      [format]
> >          subjectprefix = kvm-unit-tests PATCH
> >  
> > -Additionally it's helpful to have a common order of file types in patches.
> > -Our chosen order attempts to place the more declarative files before
> > -the code files. We also start with common code and finish with unit test
> > -code. git-diff's orderFile feature allows us to specify the order in a
> > -file. The orderFile we use is `scripts/git.difforder`. Adding the config
> > -with `git config diff.orderFile scripts/git.difforder` enables it.
> > +Additionally it is helpful to have a common order of file types in
> > +patches. Our chosen order attempts to place the more declarative files
> > +before the code files. We also start with common code and finish with
> > +unit test code. git-diff's orderFile feature allows us to specify the
> > +order in a file. The orderFile we use is `scripts/git.difforder`.
> > +Adding the config with `git config diff.orderFile
> > +scripts/git.difforder` enables it.
> 
> Why change the line length of all the above lines?
> 
> > +
> > +Please run the kernel's ./scripts/checkpatch.pl on new patches

I also just noticed you're still saying just 'patches' here. All
patches are new. You mean 'on patches to new files', or something
like that.

> 
> I'd extend this with something like
> 
>  , as we use the kernel's coding style. Note, not all kernel checks
>  apply, so a 100% error free check is not required.
> 
> Thanks,
> drew
> 
> > -- 
> > 2.11.0
> > 
--
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
diff mbox

Patch

diff --git a/README.md b/README.md
index b6f011d..c052dff 100644
--- a/README.md
+++ b/README.md
@@ -79,9 +79,12 @@  You can add the following to .git/config to do this automatically for you:
     [format]
         subjectprefix = kvm-unit-tests PATCH
 
-Additionally it's helpful to have a common order of file types in patches.
-Our chosen order attempts to place the more declarative files before
-the code files. We also start with common code and finish with unit test
-code. git-diff's orderFile feature allows us to specify the order in a
-file. The orderFile we use is `scripts/git.difforder`. Adding the config
-with `git config diff.orderFile scripts/git.difforder` enables it.
+Additionally it is helpful to have a common order of file types in
+patches. Our chosen order attempts to place the more declarative files
+before the code files. We also start with common code and finish with
+unit test code. git-diff's orderFile feature allows us to specify the
+order in a file. The orderFile we use is `scripts/git.difforder`.
+Adding the config with `git config diff.orderFile
+scripts/git.difforder` enables it.
+
+Please run the kernel's ./scripts/checkpatch.pl on new patches