New build profile and docs #3005
Conversation
|
/morph test |
Result: FAILUREYour command has finished executing! Here's what you wrote!
Outputmbed Build Number: 0 Build Prep failed! |
|
/morph test |
Result: SUCCESSYour command has finished executing! Here's what you wrote!
Outputmbed Build Number: 0 All builds and test passed! |
| # Build Profiles | ||
| Mbed 5.0 supports three primary build profiles, *default*, *debug* and *small*. When using | ||
| the online compiler the *default* profile is used. When building from the command line | ||
| the desired profile can be can be selected by adding the ```--profile mbed-os/tools/<profile>``` command line flag. |
There was a problem hiding this comment.
should we also or just use --profile as it's much user-friendly than path_to_profiles/ ?
There was a problem hiding this comment.
In that case, what about user provided profiles ? Are they still supported ?
There was a problem hiding this comment.
It would be nice if the 3 built-in profiles could be used without specifying the full path. This isn't the case currently though, so the docs should be updated in the PR that makes this change. In that case I would vote for keeping user provided profiles.
There was a problem hiding this comment.
Actually it is, my change was merged week ago you can pass only the profile name eg debug as long as it's in the mbed-os/tools/profiles/*.json and the full path still works.
There was a problem hiding this comment.
Ah cool, then I'll update the docs here
| @@ -0,0 +1,19 @@ | |||
| # Build Profiles | |||
| Mbed 5.0 supports three primary build profiles, *default*, *debug* and *small*. When using | |||
There was a problem hiding this comment.
Looking at this, I am missing which build is what usually SDK has "release build", are small and default to be considered release ("Hard to follow code flow when using a debugger") . Or to state that optimizations are enabled, that would be a good hint for users?
There was a problem hiding this comment.
I'm not sure what you are asking here. Everything by default will be using the default profile. The Default and Small profiles are for ideal for release builds, but even a debug build could be released if the slower speed and larger code size isn't a problem.
Add a small build profile and general docs for build profiles.
Remove profiles which are not suitable for building stand alone. This leaves just the 3 core profiles.
c1728p9
force-pushed
the
build_profiles
branch
from
848a693 to
23af242
Compare
|
Rebased and updated the docs to get rid of the path to the profile. |
|
/morph test |
Result: SUCCESSYour command has finished executing! Here's what you wrote!
Outputmbed Build Number: 946 All builds and test passed! |
|
LGTM as well. |
Add a small build profile and general docs for build profiles.