Skip to content

Commit 1dd9881

Browse files
committed
docs: Update usage of CONFIG CMake variable
The function of the CONFIG CMake variable has slightly changed to not perform a copy of the selected .defconfig file. Update the documentation to make this behavior clear. Signed-off-by: Andrew Davis <afd@ti.com>
1 parent 40e74b0 commit 1dd9881

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,29 @@ git submodule update --init --recursive
2727

2828
## Configure drivers and libraries
2929

30+
By default `lv_conf.defaults` is by used to generate the configuration header
31+
file `lv_conf.h` that is used during the build.
3032
Adjust `lv_conf.defaults` to select the drivers and libraries that will be compiled by
3133
modifying the following definitions, setting them to `1` or `0`
3234

3335
You can also start with a default config based on the drivers you want to use,
34-
you can find a default config for each graphic driver inside the configs folder.
36+
you can find a default config for each graphic driver inside the `configs/` directory.
3537

36-
You can either replace `lv_conf.defaults` manually or using CMake
38+
You can either replace `lv_conf.defaults` manually before configuring:
39+
40+
```bash
41+
mv configs/<config_name>.defaults lv_conf.defaults
42+
cmake -B build
43+
```
44+
45+
or have CMake directly use that file in-place during configuration:
3746

3847
```bash
3948
cmake -B build -DCONFIG=<config_name>
4049
```
4150

42-
With `<config_name>` the name of the config without the `.defaults` extension, eg: `configs/wayland.defaults` becomes `wayland`.
51+
With `<config_name>` the name of the config without the `.defaults` extension,
52+
eg: `-DCONFIG=wayland` will use `configs/wayland.defaults`.
4353

4454
### Graphics drivers
4555

lv_conf.defaults

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This file gets converted into a `lv_conf.h` at compile time
22
# A list of all configuration options can be found inside `lvgl/lv_conf_template.h`
33
# You can also start from a vast list of configs inside the configs folder.
4-
# Use cmake to copy it into your workspace:
4+
# To use one of those configs directly, set the `CONFIG` CMake variable:
55
# eg: `cmake -B build -DCONFIG=drm-egl-2d` for `configs/drm-egl-2d.defaults`
66

77
LV_COLOR_DEPTH 16

0 commit comments

Comments
 (0)