buildroot.buildroot.org archive mirror
 help / color / mirror / Atom feed
From: Yann E. MORIN <yann.morin.1998@free.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 6 of 8] manual: contributing: minor rewording of 'submitting patches' section
Date: Wed, 5 Mar 2014 18:26:47 +0100	[thread overview]
Message-ID: <20140305172647.GF5066@free.fr> (raw)
In-Reply-To: <e71bbcb3a276227ed93f.1394036672@argentina>

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.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

  reply	other threads:[~2014-03-05 17:26 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-05 16:24 [Buildroot] [PATCH 0 of 8] manual: rework Contributing chapter Thomas De Schampheleire
2014-03-05 16:24 ` [Buildroot] [PATCH 1 of 8] manual: contributing: expand introduction Thomas De Schampheleire
2014-03-05 17:11   ` Yann E. MORIN
2014-03-05 20:50     ` Samuel Martin
2014-03-05 16:24 ` [Buildroot] [PATCH 2 of 8] manual: contributing: add section on analyzing bug reports Thomas De Schampheleire
2014-03-05 17:37   ` Yann E. MORIN
2014-03-05 20:51     ` Samuel Martin
2014-03-05 16:24 ` [Buildroot] [PATCH 3 of 8] manual: contributing: move and expand autobuild section Thomas De Schampheleire
2014-03-05 17:48   ` Yann E. MORIN
2014-03-05 16:24 ` [Buildroot] [PATCH 4 of 8] manual: contributing: move section on patch reviews up and change intro Thomas De Schampheleire
2014-03-05 17:41   ` Yann E. MORIN
2014-03-05 20:57     ` Samuel Martin
2014-03-06  6:33   ` Arnout Vandecappelle
2014-03-05 16:24 ` [Buildroot] [PATCH 5 of 8] manual: contributing: add section on TODO list Thomas De Schampheleire
2014-03-05 17:17   ` Yann E. MORIN
2014-03-05 16:24 ` [Buildroot] [PATCH 6 of 8] manual: contributing: minor rewording of 'submitting patches' section Thomas De Schampheleire
2014-03-05 17:26   ` Yann E. MORIN [this message]
2014-03-06  6:39     ` Arnout Vandecappelle
2014-03-05 17:29   ` Yann E. MORIN
2014-03-05 20:59     ` Samuel Martin
2014-03-05 16:24 ` [Buildroot] [PATCH 7 of 8] manual: contributing: don't recommend leaving out changelog from patches Thomas De Schampheleire
2014-03-05 17:22   ` Yann E. MORIN
2014-03-05 16:24 ` [Buildroot] [PATCH 8 of 8] manual: contributing: minor rewording of 'reporting bugs' section Thomas De Schampheleire
2014-03-05 17:45   ` Yann E. MORIN
2014-03-05 21:05   ` Samuel Martin
2014-03-06  8:55     ` Thomas De Schampheleire
2014-03-06  9:21       ` Samuel Martin
2014-03-05 18:45 ` [Buildroot] [PATCH 0 of 8] manual: rework Contributing chapter Thomas Petazzoni

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140305172647.GF5066@free.fr \
    --to=yann.morin.1998@free.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).