From patchwork Sun Feb 19 22:17:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ricardo Martincoski X-Patchwork-Id: 729670 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3vRLsP2tsPz9s7R for ; Mon, 20 Feb 2017 09:24:25 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="XOKGMEuF"; dkim-atps=neutral Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id C30D3883C2; Sun, 19 Feb 2017 22:24:23 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id UXcF3wKCG983; Sun, 19 Feb 2017 22:24:22 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by fraxinus.osuosl.org (Postfix) with ESMTP id 5C58C8835F; Sun, 19 Feb 2017 22:24:22 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by ash.osuosl.org (Postfix) with ESMTP id E62071C1650 for ; Sun, 19 Feb 2017 22:24:20 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id E09402A12A for ; Sun, 19 Feb 2017 22:24:20 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ajLW2RxlK+Fv for ; Sun, 19 Feb 2017 22:24:20 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-qk0-f194.google.com (mail-qk0-f194.google.com [209.85.220.194]) by silver.osuosl.org (Postfix) with ESMTPS id 15D0D1FEED for ; Sun, 19 Feb 2017 22:24:20 +0000 (UTC) Received: by mail-qk0-f194.google.com with SMTP id n127so1266112qkf.2 for ; Sun, 19 Feb 2017 14:24:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :in-reply-to:references; bh=3Om+iZeEolmLvxUM6FMgOUCGC88n0/YOqRfUAPniV/8=; b=XOKGMEuFrccgmoP13omvhKdGmVGbAoyQ7JWcA3vj7AJgLTHUklZSR44OHXGb0a1dT9 HVW8qOQlJ7A6HEFbaXN5Ujp1m5bpKYyjKG/O95puOSGoCyFVy0IP+DBRb8glQ1rraIO7 xT5+gFVmLkD5NUshW0Fs+FDohOB29FBz0YK5ZYEfyZ5k677L4Cv64zplk0BPNWA49Q7D DAETboDgB5c4gCjuyQA6MN5haKI4pvPUomEuOf4e5FgJlvojqBw2GL8Fcn0FBWuLqKtx KnztabPbkVotBx3b3K8JCWZOJ6RTCfF27uSef3cHNNzoNMdRsnk1/FBw3B25bqWgY61y TgQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=3Om+iZeEolmLvxUM6FMgOUCGC88n0/YOqRfUAPniV/8=; b=ikxYzHUbjytsC9bgpN5h1BegrdxMguzC/JGVcrAOMsjkkcQjwVfgMdoqkLUJpUHTcD /vHfbwgDRA1+ONFxUg8IWVgIH0alSLVvTlUQH2IjIoIyl6qKAp3YyoUSN5tnmmMynuWU iMv+MV7Xuz31wz6OggXTVGkq+tTT3FmZBbVmed1P9v9Bh9olycktKqSyUq1jxqIlYNpc +CiWERllzAd5Q6IqzAXz3dW5dhih6tILw40VNfl0EqLYjVODO9xKfCgaZJ9UTTkcRSnP kjhSzdsGcybvXwEyrWm2KYQqkqUxXSG4H3sKAtRZLW6WAsyaDEiOLEzy7XegA8DsQi2O CHFA== X-Gm-Message-State: AMke39lFNOK9ck782hoJcJx5uvIAj4zJTlbXmD4AQWl9nzgq/ab9sAvx6y3qml6JX8AZ2A== X-Received: by 10.55.18.82 with SMTP id c79mr17354197qkh.119.1487543059056; Sun, 19 Feb 2017 14:24:19 -0800 (PST) Received: from ultri3.home ([201.86.219.185]) by smtp.gmail.com with ESMTPSA id d127sm10970245qka.30.2017.02.19.14.24.16 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 19 Feb 2017 14:24:18 -0800 (PST) From: Ricardo Martincoski To: buildroot@buildroot.org Date: Sun, 19 Feb 2017 19:17:22 -0300 Message-Id: <20170219221724.27298-8-ricardo.martincoski@gmail.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170219221724.27298-1-ricardo.martincoski@gmail.com> References: <20170219221724.27298-1-ricardo.martincoski@gmail.com> In-Reply-To: <20161231032110.11573-1-ricardo.martincoski@gmail.com> References: <20161231032110.11573-1-ricardo.martincoski@gmail.com> Cc: Thomas Petazzoni , Romain Naour , Thomas De Schampheleire , Ricardo Martincoski Subject: [Buildroot] [PATCH v2 7/9] docs/manual: size of tab in package description X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.18-1 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: "buildroot" Explicitly state that one tab counts for 8 columns in package description, leaving 62 characters to the text itself. Update the text and the example in the two places where the Config.in format is described. Also mention a newline is expected between the help text itself and the upstream URL. This blob can help developers to understand the expected formatting. Also, it can be referenced by reviewers. http://patchwork.ozlabs.org/patch/611289/ http://patchwork.ozlabs.org/patch/606866/ http://patchwork.ozlabs.org/patch/459960/ Signed-off-by: Ricardo Martincoski Cc: Arnout Vandecappelle Cc: Thomas Petazzoni Cc: Romain Naour --- Changes v1 -> v2: - add url to past reviews to the commit message (after comments from Romain); --- Notes: The next patch in this series generates a warning for each line of help text that does not comply to: <2 spaces><62 chars> docs/manual/adding-packages-directory.txt | 8 +++++--- docs/manual/writing-rules.txt | 6 ++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt index 5dba962bd..08f5d42f9 100644 --- a/docs/manual/adding-packages-directory.txt +++ b/docs/manual/adding-packages-directory.txt @@ -28,7 +28,8 @@ contain: config BR2_PACKAGE_LIBFOO bool "libfoo" help - This is a comment that explains what libfoo is. + This is a comment that explains what libfoo is. The help text + should be wrapped. http://foosoftware.org/libfoo/ --------------------------- @@ -36,8 +37,9 @@ config BR2_PACKAGE_LIBFOO The +bool+ line, +help+ line and other metadata information about the configuration option must be indented with one tab. The help text itself should be indented with one tab and two spaces, lines should -not be longer than 72 columns, and it must mention the upstream URL -of the project. +be wrapped to fit 72 columns, where tab counts for 8, so 62 characters +in the text itself. The help text must mention the upstream URL of the +project after an empty line. As a convention specific to Buildroot, the ordering of the attributes is as follows: diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt index ec1ddb191..e2ad41ebc 100644 --- a/docs/manual/writing-rules.txt +++ b/docs/manual/writing-rules.txt @@ -29,7 +29,8 @@ config BR2_PACKAGE_LIBFOO depends on BR2_PACKAGE_LIBBAZ select BR2_PACKAGE_LIBBAR help - This is a comment that explains what libfoo is. + This is a comment that explains what libfoo is. The help text + should be wrapped. http://foosoftware.org/libfoo/ --------------------- @@ -40,7 +41,8 @@ config BR2_PACKAGE_LIBFOO * The help text itself should be indented with one tab and two spaces. -* The help text should be wrapped to fit 72 columns. +* The help text should be wrapped to fit 72 columns, where tab counts + for 8, so 62 characters in the text itself. The +Config.in+ files are the input for the configuration tool used in Buildroot, which is the regular _Kconfig_. For further