cwanda commented on a change in pull request #213: Updated bletiny docs and
added btshell docs
URL: https://github.com/apache/mynewt-site/pull/213#discussion_r125474678
##########
File path: docs/os/tutorials/add_shell.md
##########
@@ -120,26 +116,46 @@ Once you have a connection set up, you can connect to
your device as follows:
To test and make sure that the Shell is running, first just hit <return>:
```no-highlight
-3534: >
+004543 compat>
```
-Remember, we turned the CONSOLE_PROMPT and the CONSOLE_TICKS on earlier. You
can try some commands now:
+bletiny app uses legacy shell API to register command callbacks. That's why
the prompt says "compat". All the legacy commands are registered to compat
module to provide backward compatibility.
Review comment:
Since we aren't planning to deprecate the shell 1.0 API and we are not
recommending one API over another - lets not use "legacy" - I recommend
something like this:
1) "bletiny app uses **legacy** shell API to register command callbacks" :
Use `the 1.0` instead of `legacy`
2) "That's why the prompt says "compat". All the legacy commands are
registered to compat module to provide backward compatibility" -> Commands
registered using the 1.0 shell API are automatically registered to the "compat"
module and have "compat" for the prompt.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
