Skip to content

Commit 108eaa5

Browse files
committed
modifying the description a bit more
1 parent 26a69b2 commit 108eaa5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/reference/configuration/configuration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ The Arm Mbed OS configuration system, a part of the Arm Mbed OS build tools, cus
77
- The receive buffer size of a serial communication library.
88
- The flash and RAM memory size of an Mbed target.
99

10-
Here is how a default JSON file might look like:
10+
The Arm Mbed OS configuration system gathers and interprets the configuration defined in the target in its [target configuration](../reference/adding-and-configuring-targets.html), all `mbed_lib.json` files and the `mbed_app.json` file. The configuration system creates a single header file, `mbed_config.h`, that contains all of the defined configuration parameters converted into C preprocessor macros.
11+
12+
Here is a sample JSON file:
1113

1214
```JSON
1315
"target_overrides": {
@@ -21,7 +23,7 @@ Here is how a default JSON file might look like:
2123
}
2224
```
2325

24-
The Arm Mbed OS configuration system gathers and interprets the configuration defined in the target in its [target configuration](../reference/adding-and-configuring-targets.html), all `mbed_lib.json` files and the `mbed_app.json` file. The configuration system creates a single header file, `mbed_config.h`, that contains all of the defined configuration parameters converted into C preprocessor macros. For instance, based on the JSON snippet above, you would see the macro, `MBED_CONF_CELLULAR_RANDOM_MAX_START_DELAY` in `mbed_config.h`. This macro will be created for all targets and would be set to `100`, whereas, macro `MBED_CONF_PLATFORM_STDIO_BAUD_RATE` will be set to `9600` only for K64F. `mbed compile` places `mbed_config.h` in the build directory, and `mbed export` places it in the application root. `mbed compile` runs the Mbed configuration system before invoking the compiler, and `mbed export` runs the configuration system before creating project files.
26+
Based on the JSON snippet above, you would see the macro, `MBED_CONF_CELLULAR_RANDOM_MAX_START_DELAY` in `mbed_config.h`. This macro will be created for all targets and would be set to `100`, whereas, macro `MBED_CONF_PLATFORM_STDIO_BAUD_RATE` will be set to `9600` only for K64F. `mbed compile` places `mbed_config.h` in the build directory, and `mbed export` places it in the application root. `mbed compile` runs the Mbed configuration system before invoking the compiler, and `mbed export` runs the configuration system before creating project files.
2527

2628
<span class="notes">**Note:** Throughout this document, "library" means any reusable piece of code within its own directory.</span>
2729

0 commit comments

Comments
 (0)