apache / apache/mynewt-core

Problems with mbuf docs?

Open
#2,289 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
891
Forks
381
Avg merge
2d 7h
Merged PRs (30d)
14

Description

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?

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the mbuf documentation at docs/os/core_os/mbuf/mbuf.html and inspect the referenced figure at docs/os/core_os/mbuf/pics/mbuf_fig1.png. Check the os_mqueue_init example against its documented parameters, including process_rx_data_queue, and verify the Data Buffer sizing. Done means the diagram and example are corrected or the questions are explicitly explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.