Enhance config system doc #931
Conversation
|
@kegilbert @SenRamakri @AnotherButler |
|
@SenRamakri @kegilbert |
Edit file, mostly for branding and active voice.
| } | ||
| ``` | ||
|
|
||
| If you use the example JSON snippet above, you can see the macro `MBED_CONF_CELLULAR_RANDOM_MAX_START_DELAY` in `mbed_config.h`. This macro is created for all targets and is set to `100`, whereas macro `MBED_CONF_PLATFORM_STDIO_BAUD_RATE` is set to `9600` only for the 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. |
There was a problem hiding this comment.
I don't understand the bit about the K64F. We don't mention it before this line. Could you please clarify?
There was a problem hiding this comment.
So if we take a look at the snippet, there are parameters that are defined under asterik (it is not letting me use that character here), and others that are defined for specific target (K64F in this case). The intent is to make sure that users understand the scope of a macro value based on the targets its defined for. Would it make the documentation clearer if I mention here that asterik is a wildcard that applies to all targets?
There was a problem hiding this comment.
I think it would, but only if our developers aren't expected to know that.
There was a problem hiding this comment.
If they are, then please ignore.
There was a problem hiding this comment.
That stuff is very basic, and it is mentioned later in this documentation.
Enhance config system documentation