From: Thomas De Schampheleire <patrickdepinguin@gmail.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 6 of 7] manual: contributing: minor rewording of 'reporting bugs' section
Date: Thu, 06 Mar 2014 11:07:34 +0100 [thread overview]
Message-ID: <979bfcee73f165aa7129.1394100454@argentina> (raw)
In-Reply-To: <patchbomb.1394100448@argentina>
This patch makes some minor fixes in the section about reporting bugs.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
---
v2: provide an explicit list of 'good' pastebins (Yann)
docs/manual/contribute.txt | 21 +++++++++++++--------
1 files changed, 13 insertions(+), 8 deletions(-)
Although I don't think this section belongs in the Contributing chapter,
there currently isn't a better place. When I get to rethinking the manual
structure, this can be changed.
diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -274,16 +274,16 @@ This can be easily handled with +git for
---------------------
[[reporting-bugs]]
-Reporting issues/bugs, get help
--------------------------------
+Reporting issues/bugs or getting help
+-------------------------------------
Before reporting any issue, please check
xref:mailing-list-subscribe[the mailing list archive] in case someone has
already reported and fixed a similar problem.
-However you choose to report bugs or get help,
-xref:bugtracker[opening a bug] or
-xref:mailing-list-subscribe[send a mail to the mailing list], there are
+However you choose to report bugs or get help, either by
+xref:bugtracker[opening a bug] or by
+xref:mailing-list-subscribe[sending a mail to the mailing list], there are
a number of details to provide in order to help people reproduce and
find a solution to the issue.
@@ -295,11 +295,16 @@ Here is a short list of details to provi
* host machine (OS/release)
* version of Buildroot
* target for which the build fails
-* package(s) which the build fails
+* package(s) for which the build fails
* the command that fails and its output
* any information you think that may be relevant
-Additionnally, your can add the +.config+ file.
+Additionally, you should add the +.config+ file (or if you know how, a
++defconfig+).
If some of these details are too large, do not hesitate to use a
-pastebin service (see http://www.similarsitesearch.com/alternatives-to/pastebin.com[]).
+pastebin service. Note that not all available pastebin services will
+preserve Unix-style line terminators when downloading raw pastes.
+Following pastebin services are known to work correctly:
+- https://gist.github.com/
+- http://code.bulix.org/
next prev parent reply other threads:[~2014-03-06 10:07 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-06 10:07 [Buildroot] [PATCH 0 of 7] manual: rework Contributing chapter Thomas De Schampheleire
2014-03-06 10:07 ` [Buildroot] [PATCH 1 of 7] manual: contributing: move and expand autobuild section Thomas De Schampheleire
2014-03-06 11:51 ` Samuel Martin
2014-03-06 10:07 ` [Buildroot] [PATCH 2 of 7] manual: contributing: move section on patch reviews up and change intro Thomas De Schampheleire
2014-03-06 11:56 ` Samuel Martin
2014-03-06 10:07 ` [Buildroot] [PATCH 3 of 7] manual: contributing: add section on TODO list Thomas De Schampheleire
2014-03-06 11:58 ` Samuel Martin
2014-03-06 10:07 ` [Buildroot] [PATCH 4 of 7] manual: contributing: minor rewording of 'submitting patches' section Thomas De Schampheleire
2014-03-06 10:07 ` [Buildroot] [PATCH 5 of 7] manual: contributing: don't recommend leaving out changelog from patches Thomas De Schampheleire
2014-03-06 11:59 ` Samuel Martin
2014-03-06 10:07 ` Thomas De Schampheleire [this message]
2014-03-06 12:02 ` [Buildroot] [PATCH 6 of 7] manual: contributing: minor rewording of 'reporting bugs' section Samuel Martin
2014-03-06 10:07 ` [Buildroot] [PATCH 7 of 7] manual: contributing: modify commit message template Thomas De Schampheleire
2014-03-06 10:10 ` [Buildroot] [PATCH 0 of 7] manual: rework Contributing chapter Thomas De Schampheleire
2014-03-06 17:28 ` 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=979bfcee73f165aa7129.1394100454@argentina \
--to=patrickdepinguin@gmail.com \
--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