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

docs/manual: add ordering of kconfig options' attributes

Browse Source 
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>
This commit is contained in:
Yann E. MORIN 2016-01-16 23:37:21 +01:00 committed by Thomas Petazzoni
parent 04d8fee3d7
commit cd6153680b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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 not be longer than 72 columns, and it must mention the upstream URL
of the project. 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+ 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 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 examples in other packages. The syntax of the +Config.in+ file is the same