Selaa lähdekoodia

docs/manual: document the new kconfig-package variable

The previous patch introduced the new FOO_KCONFIG_DEFCONFIG variable
to specify a defconfig rule rather than a (def)config file.

Add this to the manual.

Also document the pre-existing FOO_KCONFIG_FILE for which the
explanations were missing altogether.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Sam Bobroff <sam.bobroff@au1.ibm.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Yann E. MORIN 9 vuotta sitten
vanhempi
commit
217493eef8
1 muutettua tiedostoa jossa 10 lisäystä ja 0 poistoa
  1. 10 0
      docs/manual/adding-packages-kconfig.txt

+ 10 - 0
docs/manual/adding-packages-kconfig.txt

@@ -46,6 +46,16 @@ This snippet creates the following make targets:
 and ensures that the source configuration file is copied to the build
 and ensures that the source configuration file is copied to the build
 directory at the right moment.
 directory at the right moment.
 
 
+There are two options to specify a configuration file to use, either
++FOO_KCONFIG_FILE+ (as in the example, above) or +FOO_KCONFIG_DEFCONFIG+.
+It is mandatory to provide either, but not both:
+
+* +FOO_KCONFIG_FILE+ specifies the path to a defconfig or full-config file
+  to be used to configure the package.
+
+* +FOO_KCONFIG_DEFCONFIG+ specifies the defconfig 'make' rule to call to
+  configure the package.
+
 In addition to these minimally required lines, several optional variables can
 In addition to these minimally required lines, several optional variables can
 be set to suit the needs of the package under consideration:
 be set to suit the needs of the package under consideration: