-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for note filters and task trace guides #1955
Add documentation for note filters and task trace guides #1955
Conversation
@v01d @xiaoxiang781216 I have added the document for note filters. |
The docs look fine, albeit there should also be some explanation inside the first section of what the note driver does. Keep in mind that not everyone (as me) is aware of what it does and how it works. |
Ok. I'll add an explanation of note driver on the top of note.rst. And, should I leave a instruction of "trace" command line options in apps/system/trace/README.md ? I couldn't find a preferable place to explain the built-in command line options in Documentation/. Or should I move it into Documentation/guides with other instructions (Installation, Quick start guide, ... etc) |
I'd always prefer to complete the reference sections before adding stuff to the guides. But if you prefer to have it there, go ahead.
Builtin commands are described here: https://nuttx.apache.org/docs/latest/components/nsh/commands.html |
69709e0
to
a229d20
Compare
@v01d I have updated the commit to incorporate all contents in https://github.com/YuuichiNakamura/nuttx-task-tracer-doc |
Summary
This PR adds the documentation of note filters and task trace function which is introduced in #1936 and apache/nuttx-apps#421
Impact
Testing