mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-07-02 19:08:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

pbuf: Update documentation for pbuf_copy

Browse Source 
Remove detail from when the method was called pbuf_take
which worked on packet queues.
This commit is contained in:
Erik Ekman 2020-06-25 10:04:43 +02:00
parent 488d4ad246
commit a49c347b7e
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/core/pbuf.c
View File

@ -941,12 +941,7 @@ pbuf_dechain(struct pbuf *p)
/**
* @ingroup pbuf
* Create PBUF_RAM copies of pbufs.
*
* Used to queue packets on behalf of the lwIP stack, such as
* ARP based queueing.
*
* @note You MUST explicitly use p = pbuf_take(p);
* Copy the contents of one packet buffer into another.
*
* @note Only one packet is copied, no packet queue!
*
@ -956,6 +951,7 @@ pbuf_dechain(struct pbuf *p)
* @return ERR_OK if pbuf was copied
* ERR_ARG if one of the pbufs is NULL or p_to is not big
* enough to hold p_from
* ERR_VAL if any of the pbufs are part of a queue
*/
err_t
pbuf_copy(struct pbuf *p_to, const struct pbuf *p_from)