diff options
Diffstat (limited to 'docs/markdown/Kconfig-module.md')
-rw-r--r-- | docs/markdown/Kconfig-module.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/markdown/Kconfig-module.md b/docs/markdown/Kconfig-module.md new file mode 100644 index 0000000..b13f7ec --- /dev/null +++ b/docs/markdown/Kconfig-module.md @@ -0,0 +1,44 @@ +--- +short-description: Unstable kconfig module +authors: + - name: Mark Schulte, Paolo Bonzini + years: [2017, 2019] + has-copyright: false +... + +# Unstable kconfig module + +This module parses Kconfig output files to allow use of kconfig +configurations in meson projects. + +**Note**:Â this does not provide kconfig frontend tooling to generate a +configuration. You still need something such as kconfig frontends (see +link below) to parse your Kconfig files, and then (after you've +choosen the configuration options), output a ".config" file. + + [kconfig-frontends]: http://ymorin.is-a-geek.org/projects/kconfig-frontends + +## Usage + +The module may be imported as follows: + +``` meson +kconfig = import('unstable-kconfig') +``` + +The following functions will then be available as methods on the object +with the name `kconfig`. You can, of course, replace the name +`kconfig` with anything else. + +### kconfig.load() + +This function loads a kconfig output file and returns a dictionary object. + +`kconfig.load()` makes no attempt at parsing the values in the +file. Therefore, true boolean values will be represented as the string "y" +and integer values will have to be converted with `.to_int()`. + +* The first (and only) argument is the path to the configuration file to + load (usually ".config"). + +**Returns**: a [dictionary object](Reference-manual.md#dictionary-object). |