From ad35a3a43d62f1588d3cd3c1e51d8626d39f0b54 Mon Sep 17 00:00:00 2001 From: Ricardo Martincoski Date: Sun, 19 Feb 2017 19:17:22 -0300 Subject: 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 Cc: Arnout Vandecappelle Cc: Thomas Petazzoni Cc: Romain Naour Signed-off-by: Thomas Petazzoni --- docs/manual/adding-packages-directory.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'docs/manual/adding-packages-directory.txt') 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: -- cgit v1.2.1