From a49c347b7ee6f17e78b81268f89fa8cff2d95580 Mon Sep 17 00:00:00 2001 From: Erik Ekman Date: Thu, 25 Jun 2020 10:04:43 +0200 Subject: [PATCH] pbuf: Update documentation for pbuf_copy Remove detail from when the method was called pbuf_take which worked on packet queues. --- src/core/pbuf.c | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/src/core/pbuf.c b/src/core/pbuf.c index a209e0ca..42c875a1 100644 --- a/src/core/pbuf.c +++ b/src/core/pbuf.c @@ -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)