diff options
| -rw-r--r-- | docs/manual/adding-packages-directory.txt | 8 | ||||
| -rw-r--r-- | docs/manual/writing-rules.txt | 6 |
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 |
