Move stats API docs to config format #837
Conversation
|
This is waiting on engineering review, docs review and a code dependency. |
|
|
There was a problem hiding this comment.
@kegilbert Good addition.. Just a small change as we discussed
|
@deepikabhavnani Thanks for the patch! |
| @@ -1,27 +1,75 @@ | |||
| ## Mbed statistics | |||
|
|
|||
| Mbed OS provides a set of functions that you can use to capture the memory and thread statistics at runtime. `mbed_stats.h` declares these functions. To enable all Mbed OS statistics, you must build code with the `MBED_ALL_STATS_ENABLED` macro. | |||
| Mbed OS provides a set of functions that you can use to capture the memory and thread statistics at runtime. `mbed_stats.h` declares these functions. To enable all Mbed OS platform statistics, you must enable the following Mbed OS configuration option: | |||
|
|
|||
There was a problem hiding this comment.
Query: Is this information already in the configuration section? If so, instead of duplicating it, can we link to it? If not, why not?
There was a problem hiding this comment.
It is sort of, it'd require some reading and understanding of how to setup the overrides in JSON. I could just say
enable
platform.cpu-stats-enabled
but think this is a bit easier for the user. It does add more things to the page though.
There was a problem hiding this comment.
We should definitely link to the config page, at least.
There was a problem hiding this comment.
Please share which config page? Also please new config will not be visible anywhere till code is merged
There was a problem hiding this comment.
There was a problem hiding this comment.
Linking to the page in addition to the snippet is a solid idea. This page has a tip note that links to the config page for reference:
|
This PR is waiting on engineering changes and a code dependency. |
Replace enabling stats API with macros to using the official config system
Co-Authored-By: kegilbert <[email protected]>
kegilbert
force-pushed
the
kegilbert-patch-1
branch
from
657d099 to
d754c34
Compare
|
@AnotherButler Blocking PR was merged, rebased and going through tests again. |
Make minor copy edits.
kegilbert
force-pushed
the
kegilbert-patch-1
branch
from
d754c34 to
1713ca3
Compare
Add tip linking to config page for additional information.
ARMmbed/mbed-os#8761 was merged, good to go!
Replace enabling stats API with macros to using the official config system.
@deepikabhavnani will this be accurate? It sounded like there was some potential changes in the required PR linked above.