michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: net: Fix net_pkt_data_access doc about cursor

Browse source 
Unlike other functions in net_pkt.h, net_pkt_data_access() doesn't change
the cursor position.

Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
This commit is contained in:
Yasushi SHOJI 2023-08-30 18:18:15 +09:00 • committed by Carles Cufí
commit cd184f4332
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/zephyr/net/net_pkt.h
View file

@ -2239,8 +2239,8 @@ struct net_pkt_data_access {
* @brief Get data from a network packet in a contiguous way
*
* @details net_pkt's cursor should be properly initialized and,
* if needed, positioned using net_pkt_skip.
* Cursor position will be updated after the operation.
* if needed, positioned using net_pkt_skip. Unlike other functions,
* cursor position will not be updated after the operation.
*
* @param pkt The network packet from where to get the data.
* @param access A pointer to a valid net_pkt_data_access describing the