aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2019-03-15 11:37:36 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2019-03-15 11:43:05 +0100
commit49076d719cf28886ad66fc13cbba8d3d94afb332 (patch)
tree7691fd0a3a2437b14977aab83d1cf2fd7e9204b5 /docs/markdown
parent647bd2839e83267bf92fc5909f1b86e630bf395f (diff)
downloadmeson-49076d719cf28886ad66fc13cbba8d3d94afb332.zip
meson-49076d719cf28886ad66fc13cbba8d3d94afb332.tar.gz
meson-49076d719cf28886ad66fc13cbba8d3d94afb332.tar.bz2
kconfig: improvements for builddir config file
Document best practices for per-builddir config file, and add a test covering loading a config file from the build directory. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Kconfig-module.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/markdown/Kconfig-module.md b/docs/markdown/Kconfig-module.md
index b13f7ec..c361b5b 100644
--- a/docs/markdown/Kconfig-module.md
+++ b/docs/markdown/Kconfig-module.md
@@ -38,6 +38,14 @@ This function loads a kconfig output file and returns a dictionary object.
file. Therefore, true boolean values will be represented as the string "y"
and integer values will have to be converted with `.to_int()`.
+Kconfig frontends usually have ".config" as the default name for the
+configuration file. However, placing the configuration file in the source
+directory limits the user to one configuration per source directory.
+In order to allow separate configurations for each build directory, as is
+the Meson standard, `meson.build` should not hardcode ".config" as the
+argument to `kconfig.load()`, and should instead make the argument to
+`kconfig.load()` a [project build option](Build-options.md).
+
* The first (and only) argument is the path to the configuration file to
load (usually ".config").