diff options
| author | Ricardo Martincoski <ricardo.martincoski@gmail.com> | 2017-02-19 19:17:22 -0300 |
|---|---|---|
| committer | Thomas Petazzoni <thomas.petazzoni@free-electrons.com> | 2017-04-08 16:15:36 +0200 |
| commit | ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54 (patch) | |
| tree | 08e3cf87c8ee9462c869cc249278f355f5128c2b /docs/manual/writing-rules.txt | |
| parent | 8e87d76c12688a34de48cc62d1a18ea13ead0784 (diff) | |
| download | buildroot-ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54.tar.gz buildroot-ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54.zip | |
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/manual/writing-rules.txt')
| -rw-r--r-- | docs/manual/writing-rules.txt | 6 |
1 files changed, 4 insertions, 2 deletions
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 |
