aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Kconfig-module.md
blob: b13f7ec49a204013d78a95921f30ae70c93ba4d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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).