Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

More Description in Example Documentation #36028

Closed
pearson opened this issue Jun 7, 2021 · 0 comments
Closed

More Description in Example Documentation #36028

pearson opened this issue Jun 7, 2021 · 0 comments

Comments

@pearson
Copy link
Contributor

pearson commented Jun 7, 2021

The documentation for examples could use to be expanded with more description of the code to help those who are new to Zephyr.

As an example, take the second in the "Classic" examples, "Synchronization":

  • Why does it do a k_busy_wait followed by a k_msleep before releasing the semaphore?
  • Why are there three ARG_UNUSED dummy variables at the start of each thread function?
  • What is the PIN_THREADS define used for, and the k_thread_cpu_mask_clear and k_thread_cpu_mask_enable calls it enables?

For someone new to Zephyr (such as myself), there are many questions that could be answered in an example's documentation rather than through searching the entire set of documentation. Getting up to speed quickly, rather than having to read through more material than is currently needed, can be very useful.

@nashif nashif closed this as completed Jun 7, 2021
@zephyrproject-rtos zephyrproject-rtos locked and limited conversation to collaborators Jun 7, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants