From patchwork Thu Mar 6 10:07:34 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas De Schampheleire X-Patchwork-Id: 327370 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from hemlock.osuosl.org (hemlock.osuosl.org [140.211.166.133]) by ozlabs.org (Postfix) with ESMTP id 95B212C00B1 for ; Thu, 6 Mar 2014 21:09:20 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id 77A07952CE; Thu, 6 Mar 2014 10:09:07 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Qn5i7ssH230I; Thu, 6 Mar 2014 10:09:05 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by hemlock.osuosl.org (Postfix) with ESMTP id F218995803; Thu, 6 Mar 2014 10:09:04 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from silver.osuosl.org (silver.osuosl.org [140.211.166.136]) by ash.osuosl.org (Postfix) with ESMTP id 8C8A41C2B3A for ; Thu, 6 Mar 2014 10:09:00 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 887CD32176 for ; Thu, 6 Mar 2014 10:09:00 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id opv9+vuzWPid for ; Thu, 6 Mar 2014 10:08:59 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-ee0-f54.google.com (mail-ee0-f54.google.com [74.125.83.54]) by silver.osuosl.org (Postfix) with ESMTPS id 2EE8126A56 for ; Thu, 6 Mar 2014 10:08:59 +0000 (UTC) Received: by mail-ee0-f54.google.com with SMTP id d49so1012704eek.13 for ; Thu, 06 Mar 2014 02:08:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=content-type:mime-version:content-transfer-encoding:subject :message-id:in-reply-to:references:user-agent:date:from:to; bh=nOTjYYKuS1vX7kMvdwJKFUHI6Llej9hq36N6ehbugIA=; b=vqTMgGlw+s6+LlURcMnJAG+pZDoKhUKF5VJ1AHM/SkK6l1NKw9/wFlHD4jDxpS0q4E aHIrMABGyr3CQ+CSDJNbWH9+Z4u+gaCmN7PmppDDyrPR8dH7SGjMX1y8CumHBF5Xrbz7 hcnyMpAkFAFB4jtKEA9BMHAKdIXt57Z3nT7C5jEbmzcjCyRrwqfiejJmSpiffRT8Fwzo j8tfjFr3X2E/FOwfgTYFLPGKtlhyzeSYmQDd8ZMJoL+qjliovad9Ip0CSC69Jf+FOmMA B2cYJkGscR2T0DElUVOaA7ASezYwqq2+/KbTm8lCh6S/HfJbWp+baxYHcZ81uN8kCTMg Um3Q== X-Received: by 10.15.41.140 with SMTP id s12mr11525566eev.4.1394100537759; Thu, 06 Mar 2014 02:08:57 -0800 (PST) Received: from [127.0.1.1] (d54C62EEB.access.telenet.be. [84.198.46.235]) by mx.google.com with ESMTPSA id o43sm20094311eef.12.2014.03.06.02.08.56 for (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 06 Mar 2014 02:08:57 -0800 (PST) MIME-Version: 1.0 X-Mercurial-Node: 979bfcee73f165aa7129fa6e76e078c14364523d Message-Id: <979bfcee73f165aa7129.1394100454@argentina> In-Reply-To: References: User-Agent: Mercurial-patchbomb/2.2.2 Date: Thu, 06 Mar 2014 11:07:34 +0100 From: Thomas De Schampheleire To: buildroot@buildroot.org Subject: [Buildroot] [PATCH 6 of 7] manual: contributing: minor rewording of 'reporting bugs' section X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net This patch makes some minor fixes in the section about reporting bugs. Signed-off-by: Thomas De Schampheleire Acked-by: Samuel Martin --- 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/