aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/writing-rules.txt
diff options
context:
space:
mode:
authorGravatar Julien Viard de Galbert <julien@vdg.name>2015-05-17 13:38:31 +0200
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2015-07-13 12:16:45 +0200
commit5284dcf7de769e8612da3d4f1c4d12b4582870d5 (patch)
treeb13a35b3e51c7f8e3ae57c86c3f04b2ad3f469ea /docs/manual/writing-rules.txt
parent3ac4bf634e16cc8b5f1f8d732da296b4e32dd734 (diff)
downloadbuildroot-5284dcf7de769e8612da3d4f1c4d12b4582870d5.tar.gz
buildroot-5284dcf7de769e8612da3d4f1c4d12b4582870d5.tar.bz2
Document the 72 char limit on package description.
While describing a package I though that the tab and 2 spaces was already doing the margin for wrapping the help test (ie 70 char when wrapping to 80) but apparently the full text need to fit 72 columns. So this patch propose to document that fact in the two places where the Config.in format is described. Signed-off-by: Julien Viard de Galbert <julien@vdg.name> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> 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.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt
index e6401a4882..ec1ddb1915 100644
--- a/docs/manual/writing-rules.txt
+++ b/docs/manual/writing-rules.txt
@@ -40,6 +40,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 +Config.in+ files are the input for the configuration tool
used in Buildroot, which is the regular _Kconfig_. For further
details about the _Kconfig_ language, refer to