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

Problems with mbuf docs? #2289

Open
cqexbesd opened this issue May 16, 2020 · 0 comments
Open

Problems with mbuf docs? #2289

cqexbesd opened this issue May 16, 2020 · 0 comments

Comments

@cqexbesd
Copy link
Contributor

I'm just reading the mbuf docs (https://mynewt.apache.org/latest/os/core_os/mbuf/mbuf.html). I am still learning so I don't want to say these are errors and not my confusion - but if that's the case then maybe the docs could be expanded to head off these questions :-)

  1. Regarding figure 1 (https://github.com/apache/mynewt-core/blob/master/docs/os/core_os/mbuf/pics/mbuf_fig1.png). The Data Buffer part of a Packet Header mbuf must be MBLEN - 24 - N bytes and not just MBLEN - 16?

  2. In the example code at the end (https://mynewt.apache.org/latest/os/core_os/mbuf/mbuf.html#using-mqueue is the closest link I can get) the call to os_mqueue_init has only two parameters when the docs further down say it should have three. I'm guessing the second parameter should be process_rx_data_queue. If not can the docs be expanded to explain how process_rx_data_queue does get called?

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

No branches or pull requests

1 participant