Commit cd615368 authored by Yann E. MORIN's avatar Yann E. MORIN Committed by Thomas Petazzoni
Browse files

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: default avatar"Yann E. MORIN" <yann.morin.1998@free.fr>
Acked-by: default avatarArnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
parent 04d8fee3

docs/manual/adding-packages-directory.txt

+9 −0
Original line number Diff line number Diff line
@@ -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