NetCube-Systems-Austria/kumquat-buildroot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the 72 char limit on package description.

Browse Source 
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>
This commit is contained in:
Julien Viard de Galbert 2015-05-17 13:38:31 +02:00 committed by Thomas Petazzoni
parent 3ac4bf634e
commit 5284dcf7de
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/manual/adding-packages-directory.txt
View File

@ -35,8 +35,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, and it must
mention the upstream URL of the project.
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.
You can add other sub-options into a +if
BR2_PACKAGE_LIBFOO...endif+ statement to configure particular things

2
docs/manual/writing-rules.txt
View File

@ -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