diff mbox

[8,of,8] manual: contributing: minor rewording of 'reporting bugs' section

Message ID c79971c9c229295a42da.1394036674@argentina
State Superseded
Headers show

Commit Message

Thomas De Schampheleire March 5, 2014, 4:24 p.m. UTC
This patch makes some minor fixes in the section about reporting bugs.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 docs/manual/contribute.txt |  15 ++++++++-------
 1 files changed, 8 insertions(+), 7 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.

Comments

Yann E. MORIN March 5, 2014, 5:45 p.m. UTC | #1
Thomas, All,

On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly:
> This patch makes some minor fixes in the section about reporting bugs.
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
> 
> ---
>  docs/manual/contribute.txt |  15 ++++++++-------
>  1 files changed, 8 insertions(+), 7 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
> @@ -266,16 +266,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.
>  
> @@ -287,11 +287,12 @@ 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+).

... the +.config+ file (or better yet, 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[]).

There are some pastebin sites which, when you download the 'raw' paste,
will send you a CRLF file. This is inconvenient, since the files have to
be converted first. Maybe we could list a pastebins that don;t do that,
and list them prominently?

Regards,
Yann E. MORIN.
Samuel Martin March 5, 2014, 9:05 p.m. UTC | #2
Hi Thomas,

On Wed, Mar 5, 2014 at 5:24 PM, Thomas De Schampheleire
<patrickdepinguin@gmail.com> wrote:
> This patch makes some minor fixes in the section about reporting bugs.
>
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>
> ---
>  docs/manual/contribute.txt |  15 ++++++++-------
>  1 files changed, 8 insertions(+), 7 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
> @@ -266,16 +266,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

We could add a link to buildroot gmane. This iscertainly the easiest
way to search the ML archive.

>  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.
>
> @@ -287,11 +287,12 @@ 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[]).
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

Regards,
Thomas De Schampheleire March 6, 2014, 8:55 a.m. UTC | #3
Hi Samuel,

On Wed, Mar 5, 2014 at 10:05 PM, Samuel Martin <s.martin49@gmail.com> wrote:
> Hi Thomas,
>
> On Wed, Mar 5, 2014 at 5:24 PM, Thomas De Schampheleire
> <patrickdepinguin@gmail.com> wrote:
>> This patch makes some minor fixes in the section about reporting bugs.
>>
>> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>>
>> ---
>>  docs/manual/contribute.txt |  15 ++++++++-------
>>  1 files changed, 8 insertions(+), 7 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
>> @@ -266,16 +266,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
>
> We could add a link to buildroot gmane. This iscertainly the easiest
> way to search the ML archive.
>

This link is already present from the 'the mailing list archive'
reference, so I don't think we should replicate it here, right?

thanks,
Thomas
Samuel Martin March 6, 2014, 9:21 a.m. UTC | #4
On Thu, Mar 6, 2014 at 9:55 AM, Thomas De Schampheleire
<patrickdepinguin@gmail.com> wrote:
> Hi Samuel,
>
> On Wed, Mar 5, 2014 at 10:05 PM, Samuel Martin <s.martin49@gmail.com> wrote:
>> Hi Thomas,
>>
>> On Wed, Mar 5, 2014 at 5:24 PM, Thomas De Schampheleire
>> <patrickdepinguin@gmail.com> wrote:
>>> This patch makes some minor fixes in the section about reporting bugs.
>>>
>>> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>>>
>>> ---
>>>  docs/manual/contribute.txt |  15 ++++++++-------
>>>  1 files changed, 8 insertions(+), 7 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
>>> @@ -266,16 +266,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
>>
>> We could add a link to buildroot gmane. This iscertainly the easiest
>> way to search the ML archive.
>>
>
> This link is already present from the 'the mailing list archive'
> reference, so I don't think we should replicate it here, right?

Fair enough!

>
> thanks,
> Thomas

Regards,
diff mbox

Patch

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -266,16 +266,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.
 
@@ -287,11 +287,12 @@  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[]).