BLE build time configuration doc #949
Conversation
docs/reference/configuration/BLE.md
Outdated
|
|
||
| These are feature that can be disabled: | ||
|
|
||
| - observer (scanning) |
There was a problem hiding this comment.
Would you be able to replace this with a table (config flag and description)?
There was a problem hiding this comment.
Where does the BLE mbed_lib.json file live? I was only able to find target specific ones and
mbed compile --config -v --prefix ble doesn't give me anything (tried with a BLE target specified as well).
A section like the other pages if this does exist would be helpful: https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/reference/configuration/Platform.md
i.e.:
Configuration parameters
------------------------
Name: ble.beepboop
....
There was a problem hiding this comment.
@paul-szczepanek-arm Pinging for above question. If the table in this doc is a list of configuration options available through the config system then the doc config list auto-updater script won't catch it unless it's formatted like the other files:
There was a problem hiding this comment.
Do I still need to write this if it's autogenerated? How do I insert the autogenerated part? May I have the script? Nevermind, it's in the PR you linked to.
|
Tagging @kegilbert as a reviewer because he's working on a script standardizing and automating config docs. |
|
markdown does not like breaklines in tables, let me fix that |
|
Is this compromise between MD rendering and plain text readability acceptable? |
|
If you like, I can play around with the table and figure out why it's not rendering right. |
|
I leave that decision to you. My guess would be that most people read docs as text files but I'm probably just projecting. |
|
@kegilbert Hi, does this work? |
Make minor copy edits, mostly for active voice and international spelling.
|
New code dependency: ARMmbed/mbed-os#9790 |
Added a doc for the not yet merged configuration feature (temporary PR: paul-szczepanek-arm/mbed-os#61)