Skip to content
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

Conversation

YuuichiNakamura
Copy link
Contributor

@YuuichiNakamura YuuichiNakamura commented Oct 9, 2020

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

@YuuichiNakamura
Copy link
Contributor Author

@v01d @xiaoxiang781216 I have added the document for note filters.
This is an introduction of only filter device. The application command introduction will be added in apache/nuttx-apps#421 as README.md

@protobits
Copy link
Contributor

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.
I was looking forward to have the docs you linked here: https://github.com/YuuichiNakamura/nuttx-task-tracer-doc
with all those nice figures and explanations.

@YuuichiNakamura
Copy link
Contributor Author

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.
I was looking forward to have the docs you linked here: https://github.com/YuuichiNakamura/nuttx-task-tracer-doc
with all those nice figures and explanations.

Ok. I'll add an explanation of note driver on the top of note.rst.
Regarding the another part of my document, how about adding them to Documentation/guides ? It seems a preferable place for the introduction.

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)

@protobits
Copy link
Contributor

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.
I was looking forward to have the docs you linked here: https://github.com/YuuichiNakamura/nuttx-task-tracer-doc
with all those nice figures and explanations.

Ok. I'll add an explanation of note driver on the top of note.rst.
Regarding the another part of my document, how about adding them to Documentation/guides ? It seems a preferable place for the introduction.

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.
The main image could be added to the doc page of this PR in any case.

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)

Builtin commands are described here: https://nuttx.apache.org/docs/latest/components/nsh/commands.html
This section is fairly large and eventually should be split for readability.
Remember that you can use the search to find where things are documented.

@YuuichiNakamura YuuichiNakamura changed the title Add note filters documentation Add documentation for note filters and task trace guides Oct 15, 2020
@YuuichiNakamura YuuichiNakamura force-pushed the feature/add-note-filter-documents branch from 69709e0 to a229d20 Compare October 15, 2020 14:54
@YuuichiNakamura
Copy link
Contributor Author

@v01d I have updated the commit to incorporate all contents in https://github.com/YuuichiNakamura/nuttx-task-tracer-doc
Currently apps/system/trace/README.md has the same contents to tasktraceuser.rst.
To reduce the maintenance cost, I'll fix the former to the reference to rst version later.

@xiaoxiang781216 xiaoxiang781216 merged commit 1472a91 into apache:master Oct 16, 2020
@YuuichiNakamura YuuichiNakamura deleted the feature/add-note-filter-documents branch October 16, 2020 06:20
@xiaoxiang781216 xiaoxiang781216 linked an issue Oct 16, 2020 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

documentation for task trace feature
3 participants