| Message ID | e71bbcb3a276227ed93f.1394036672@argentina |
|---|---|
| State | Superseded |
| Headers | show |
Thomas, All, Not directly related to your patch... On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly: > @@ -236,7 +238,7 @@ Hereafter the recommended layout: > --------------- > Patch title less than 80-character length > > -Some more paragraph giving some more details. > +A paragraph giving more details. > > And yet another paragraph giving more details. I like it when commit log are describing what the problem is, what the reason is, and how it is solved. Something like: Patch title: short explanation, less than 80 chars A paragraph that explains the problem, and how it manifests itself. If the problem is complex, it is OK to add more paragraph. A paragraph that explains the root cause of the problem. Again, more than on paragraph is OK. Finally, a paragraph than explains how it is solved. Signed-off-by: John DOE <john.doe@example.net> Regards, Yann E. MORIN.
Thomas, All, On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly: > This patch makes some minor changes to the section about submitting patches. > Content-wise there are little changes. > > Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Regards, Yann E. MORIN. > --- > docs/manual/contribute.txt | 20 +++++++++++--------- > 1 files changed, 11 insertions(+), 9 deletions(-) > > diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt > --- a/docs/manual/contribute.txt > +++ b/docs/manual/contribute.txt > @@ -156,16 +156,18 @@ Submitting patches > _Please, do not attach patches to bugs, send them to the mailing list > instead_. > > -When your changes are done, and committed in your local git view, > -_rebase_ your development branch on top of the upstream tree before > -generating the patch set. To do so, run: > +If you made some changes to Buildroot and you would like to contribute > +them to the Buildroot project, proceed as follows. Starting from the > +changes committed in your local git view, _rebase_ your development > +branch on top of the upstream tree before generating a patch set. To do > +so, run: > > --------------------- > $ git fetch --all --tags > $ git rebase origin/master > --------------------- > > -Here, you are ready to generate then submit your patch set. > +Now, you are ready to generate then submit your patch set. > > To generate it, run: > > @@ -177,7 +179,7 @@ This will generate patch files in the +o > automatically adding the +Signed-off-by+ line. > > Once patch files are generated, you can review/edit the commit message > -before submitting them using your favorite text editor. > +before submitting them, using your favorite text editor. > > Lastly, send/submit your patch set to the Buildroot mailing list: > > @@ -188,9 +190,9 @@ Lastly, send/submit your patch set to th > Note that +git+ should be configured to use your mail account. > To configure +git+, see +man git-send-email+ or google it. > > -Make sure posted *patches are not line-wrapped*, otherwise they cannot > -easily be applied. In such a case, fix your e-mail client, or better, > -use +git send-email+ to send your patches. > +If you do not use +git send-email+, make sure posted *patches are not > +line-wrapped*, otherwise they cannot easily be applied. In such a case, > +fix your e-mail client, or better yet, learn to use +git send-email+. > > Cover letter > ~~~~~~~~~~~~ > @@ -236,7 +238,7 @@ Hereafter the recommended layout: > --------------- > Patch title less than 80-character length > > -Some more paragraph giving some more details. > +A paragraph giving more details. > > And yet another paragraph giving more details. > > _______________________________________________ > buildroot mailing list > buildroot@busybox.net > http://lists.busybox.net/mailman/listinfo/buildroot
On Wed, Mar 5, 2014 at 6:29 PM, Yann E. MORIN <yann.morin.1998@free.fr> wrote: > Thomas, All, > > On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly: >> This patch makes some minor changes to the section about submitting patches. >> Content-wise there are little changes. >> >> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> > > Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Regards,
On 05/03/14 18:26, Yann E. MORIN wrote: > Thomas, All, > > Not directly related to your patch... > > On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly: >> @@ -236,7 +238,7 @@ Hereafter the recommended layout: >> --------------- >> Patch title less than 80-character length >> >> -Some more paragraph giving some more details. >> +A paragraph giving more details. >> >> And yet another paragraph giving more details. > > I like it when commit log are describing what the problem is, what the > reason is, and how it is solved. Something like: > > Patch title: short explanation, less than 80 chars Actually, everything should be wrapped at 72 chars, since 'git log' indents with a tab. Regards, Arnout > > A paragraph that explains the problem, and how > it manifests itself. If the problem is complex, > it is OK to add more paragraph. > > A paragraph that explains the root cause of the problem. > Again, more than on paragraph is OK. > > Finally, a paragraph than explains how it is solved. > > Signed-off-by: John DOE <john.doe@example.net> > > Regards, > Yann E. MORIN. >
diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt --- a/docs/manual/contribute.txt +++ b/docs/manual/contribute.txt @@ -156,16 +156,18 @@ Submitting patches _Please, do not attach patches to bugs, send them to the mailing list instead_. -When your changes are done, and committed in your local git view, -_rebase_ your development branch on top of the upstream tree before -generating the patch set. To do so, run: +If you made some changes to Buildroot and you would like to contribute +them to the Buildroot project, proceed as follows. Starting from the +changes committed in your local git view, _rebase_ your development +branch on top of the upstream tree before generating a patch set. To do +so, run: --------------------- $ git fetch --all --tags $ git rebase origin/master --------------------- -Here, you are ready to generate then submit your patch set. +Now, you are ready to generate then submit your patch set. To generate it, run: @@ -177,7 +179,7 @@ This will generate patch files in the +o automatically adding the +Signed-off-by+ line. Once patch files are generated, you can review/edit the commit message -before submitting them using your favorite text editor. +before submitting them, using your favorite text editor. Lastly, send/submit your patch set to the Buildroot mailing list: @@ -188,9 +190,9 @@ Lastly, send/submit your patch set to th Note that +git+ should be configured to use your mail account. To configure +git+, see +man git-send-email+ or google it. -Make sure posted *patches are not line-wrapped*, otherwise they cannot -easily be applied. In such a case, fix your e-mail client, or better, -use +git send-email+ to send your patches. +If you do not use +git send-email+, make sure posted *patches are not +line-wrapped*, otherwise they cannot easily be applied. In such a case, +fix your e-mail client, or better yet, learn to use +git send-email+. Cover letter ~~~~~~~~~~~~ @@ -236,7 +238,7 @@ Hereafter the recommended layout: --------------- Patch title less than 80-character length -Some more paragraph giving some more details. +A paragraph giving more details. And yet another paragraph giving more details.
This patch makes some minor changes to the section about submitting patches. Content-wise there are little changes. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> --- docs/manual/contribute.txt | 20 +++++++++++--------- 1 files changed, 11 insertions(+), 9 deletions(-)