Skip to content

netdev: document valid values for iolist in send()#11195

Merged
1 commit merged intoRIOT-OS:masterfrom
miri64:netdev/enh/send-iolist-doc
Mar 15, 2019
Merged

netdev: document valid values for iolist in send()#11195
1 commit merged intoRIOT-OS:masterfrom
miri64:netdev/enh/send-iolist-doc

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Mar 15, 2019

Contribution description

Updates the documentation of netdev_driver_t::send() according to #11163.

Testing procedure

Read!

Issues/PRs references

Addresses #11163

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: network Area: Networking Area: doc Area: Documentation Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Mar 15, 2019
@miri64 miri64 requested review from bergzand and kaspar030 March 15, 2019 10:36
@miri64 miri64 changed the title iolist: document valid values for iolist in send() netdev: document valid values for iolist in send() Mar 15, 2019
Copy link
Copy Markdown

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Information is helping and doc looks good. ACK

@ghost ghost merged commit a46927c into RIOT-OS:master Mar 15, 2019
* @param[in] iolist io vector list to send
* @param[in] iolist IO vector list to send. Elements of this list may
* have iolist_t::iol_data == NULL or
* iolist_t::iol_size == 0. However, unless otherwise
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this again?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is what?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the first half of the line see #11163, for the second see #11187 (review).

@miri64 miri64 deleted the netdev/enh/send-iolist-doc branch March 15, 2019 12:16
@danpetry danpetry added this to the Release 2019.04 milestone Mar 26, 2019
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation Area: drivers Area: Device drivers Area: network Area: Networking CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants