aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Yann E. MORIN <yann.morin.1998@free.fr>2016-01-16 23:37:21 +0100
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2016-01-19 22:24:34 +0100
commitcd6153680bc39bab0664b0a77136e3d13425937e (patch)
tree6d81d447957bf385e2bc3ada3ff49152493c43ef /docs
parent04d8fee3d7dd826de5376e153634d2bad2605cf2 (diff)
downloadbuildroot-cd6153680bc39bab0664b0a77136e3d13425937e.tar.gz
buildroot-cd6153680bc39bab0664b0a77136e3d13425937e.tar.bz2
docs/manual: add ordering of kconfig options' attributes
We want to ensure all packages follow the same coding style, so we add a blurb about the order of kconfig options' attributes: - first, the type and the prompt - the default value if needed - then dependencies of the 'depends on' category - followed by dependencies of the 'select' form - with eventually the help text Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/adding-packages-directory.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index d0de35831c..b9596a28ca 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -39,6 +39,15 @@ 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.
+As a convention specific to Buildroot, the ordering of the attributes
+is as follows:
+
+1. The type of option: +bool+, +string+... with the prompt
+2. If needed, the +default+ value(s)
+3. Any dependency of the +depends on+ form
+4. Any dependency of the +select+ form
+5. The help keyword and help text.
+
You can add other sub-options into a +if BR2_PACKAGE_LIBFOO...endif+
statement to configure particular things in your software. You can look at
examples in other packages. The syntax of the +Config.in+ file is the same