aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Ricardo Martincoski <ricardo.martincoski@gmail.com>2017-02-19 19:17:22 -0300
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2017-04-08 16:15:36 +0200
commitad35a3a43d62f1588d3cd3c1e51d8626d39f0b54 (patch)
tree08e3cf87c8ee9462c869cc249278f355f5128c2b /docs
parent8e87d76c12688a34de48cc62d1a18ea13ead0784 (diff)
downloadbuildroot-ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54.tar.gz
buildroot-ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54.tar.bz2
docs/manual: size of tab in package description
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 <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/adding-packages-directory.txt8
-rw-r--r--docs/manual/writing-rules.txt6
2 files changed, 9 insertions, 5 deletions
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 5dba962bd4..08f5d42f91 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 ec1ddb1915..e2ad41ebc3 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