path: root/docs
diff options
authorGravatar Yann E. MORIN <yann.morin.1998@free.fr>2015-12-22 22:22:01 +0100
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2015-12-22 22:39:26 +0100
commit217493eef8624b220e62ea39a8ddddc8678f6700 (patch)
tree0eded115fdf78b29042983277219f3fbd021a847 /docs
parent8ef62b996b9f2fa04d907885b16ae7caa199c617 (diff)
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>
Diffstat (limited to 'docs')
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-kconfig.txt b/docs/manual/adding-packages-kconfig.txt
index 17f91e3f2d..3290024b09 100644
--- a/docs/manual/adding-packages-kconfig.txt
+++ b/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
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
be set to suit the needs of the package under consideration: