Skip to content

Commit e897c5d

Browse files
committed
Added description for make config
1 parent ca9ffba commit e897c5d

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

docs/compile.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ To enable specific compile options, use environment variables while calling make
77

88
`make CORTEX_M0=1`
99

10+
As an alternative, you can provide a .config file in the root directory of wolfBoot.
11+
Command line options have priority on `.config` options, as long as .config options are
12+
defined using the `?=` operator, e.g.:
13+
14+
`WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x14000`
15+
16+
## Generate a new configuration
17+
18+
A new `.config` file with a set of default parameters
19+
can be generated by running `make config`. The build script will ask to enter a default value for
20+
each configuration parameter. Enter confirm the current value, indicated in between `[]`.
21+
22+
Once a .config file is in place, it will change the default compile-time options when running `make`
23+
without parameters.
24+
25+
.config can be modified with a text editor to alter the default options later on.
26+
1027
## Platform selection
1128

1229
If supported natively, the target platform can be specified using the `TARGET` variable.
@@ -27,9 +44,9 @@ By default, wolfBoot is compiled for ARM Cortex-M3/4/7. To compile for Cortex-M0
2744

2845
### Flash partitions
2946

30-
The file [include/target.h](../include/target.h) must be modified according to flash geometry,
47+
The file [include/target.h](../include/target.h) is generated according to the configured flash geometry,
3148
partitions size and offset of the target system. The following values must be set to provide the
32-
desired flash configuration:
49+
desired flash configuration, either via the command line, or using the .config file as
3350

3451
`WOLFBOOT_SECTOR_SIZE`
3552

0 commit comments

Comments
 (0)