From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7781CA04DD for ; Wed, 28 Oct 2020 11:56:24 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6ADBBCAD4; Wed, 28 Oct 2020 11:56:23 +0100 (CET) Received: from mail-wm1-f54.google.com (mail-wm1-f54.google.com [209.85.128.54]) by dpdk.org (Postfix) with ESMTP id 378F4CAD0 for ; Wed, 28 Oct 2020 11:56:22 +0100 (CET) Received: by mail-wm1-f54.google.com with SMTP id w23so4107587wmi.4 for ; Wed, 28 Oct 2020 03:56:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=6zzFXm5govCdIhlbFbgSr5mysYc1DmZ9CASWDcjJHQQ=; b=M72ElENHDD5v6vlBxQ4QtQPhGz1dComN91QxufngjkyCtdUYjHl3YyRacYRcx1iWYf RoaVQV13ef+ZDOgcJGj4buS0AhZa8pcpSS2VooM/9PqO4V9NIb5hBEE6xI7iwzf48Qnb vL8nnI2pXHaE2wuaSSreh88l3fhjnXVmthIByBmGA5xlZs8Z6rQo6WrgS673yOp1SK/d QRGxfeE8l5KnubEcGt2nBSRZmjJcfujHQjQXpg/wvMv9lgA6j4gJgug138vFr3ZxDrNk JGbG8ogZWJL9JZ9d28leBJD+ZZKPF7N6eKBSpfjnH+58fgpM8ILt1PFn3KedvKD1cOoK Q97Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=6zzFXm5govCdIhlbFbgSr5mysYc1DmZ9CASWDcjJHQQ=; b=YQMAgtvJXIZQl/IY60F8RC1IriQOeawpIzveWVtx51IohkLr+FyRs3/o/0KfF66h+g dv0jdFVLngfzM8fJoEt4rGz7TH5YOFj3C5joTB+WLNgkQUXxSgzTNE+um4XBtPGwV2GY oG+vivcyI8yFzHuVfwF42hs2B/zg4BFJBe78BYhLSx5/8KlW2UGjsTo1Ts7kI5vbFoYx CaXSQs4MPVGEfru1BT/vSdT5tcaqcqhW1xKGKXPSSFWaceCuWPt0luqMMUsyHgIGuoxx 1CknDiQfCAS2iXJJqqNopnFHFoHAfmz/zPYuDwpw8/E8vLcqlU5K6dfKY5g5wwYfy20I 6xpg== X-Gm-Message-State: AOAM531ZqaSDuS+j2uv9i2ye7eecVynuUnUoUaE5PfgSM0UVm43ZwUM9 rZcLrB0exUyaH26uPoHAvoIcyJ7Uf9L4ckDW X-Google-Smtp-Source: ABdhPJy8idmx6sYTl5eOkUqU7Kf0hnlKdoOC3o8nI/EaQzH+b4HSkgqbVoB2VxqkDfcA2nn8mtS1LQ== X-Received: by 2002:a1c:c2c5:: with SMTP id s188mr7734239wmf.174.1603882580969; Wed, 28 Oct 2020 03:56:20 -0700 (PDT) Received: from localhost ([88.98.246.218]) by smtp.gmail.com with ESMTPSA id p1sm5392584wrx.3.2020.10.28.03.56.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 28 Oct 2020 03:56:20 -0700 (PDT) From: luca.boccassi@gmail.com To: Lukasz Wojciechowski Cc: David Hunt , dpdk stable Date: Wed, 28 Oct 2020 10:45:50 +0000 Message-Id: <20201028104606.3504127-191-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20201028104606.3504127-1-luca.boccassi@gmail.com> References: <20201028104606.3504127-1-luca.boccassi@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-stable] patch 'distributor: fix API documentation' has been queued to stable release 19.11.6 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" Hi, FYI, your patch has been queued to stable release 19.11.6 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 10/30/20. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Thanks. Luca Boccassi --- >From 7c3f944d2fec17fad74d96e36fa93dcd6d0aad84 Mon Sep 17 00:00:00 2001 From: Lukasz Wojciechowski Date: Sat, 17 Oct 2020 05:06:54 +0200 Subject: [PATCH] distributor: fix API documentation [ upstream commit ed4be82d9e645c86ccd16938bdb200cdecaa2906 ] After introducing burst API there were some artefacts in the API documentation from legacy single API. Also the rte_distributor_poll_pkt() function return values mismatched the implementation. Fixes: c0de0eb82e40 ("distributor: switch over to new API") Signed-off-by: Lukasz Wojciechowski Acked-by: David Hunt --- lib/librte_distributor/rte_distributor.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/lib/librte_distributor/rte_distributor.h b/lib/librte_distributor/rte_distributor.h index 327c0c4ab2..a073e64612 100644 --- a/lib/librte_distributor/rte_distributor.h +++ b/lib/librte_distributor/rte_distributor.h @@ -155,7 +155,7 @@ rte_distributor_clear_returns(struct rte_distributor *d); * @param pkts * The mbufs pointer array to be filled in (up to 8 packets) * @param oldpkt - * The previous packet, if any, being processed by the worker + * The previous packets, if any, being processed by the worker * @param retcount * The number of packets being returned * @@ -187,15 +187,15 @@ rte_distributor_return_pkt(struct rte_distributor *d, /** * API called by a worker to request a new packet to process. - * Any previous packet given to the worker is assumed to have completed + * Any previous packets given to the worker are assumed to have completed * processing, and may be optionally returned to the distributor via * the oldpkt parameter. - * Unlike rte_distributor_get_pkt_burst(), this function does not wait for a - * new packet to be provided by the distributor. + * Unlike rte_distributor_get_pkt(), this function does not wait for + * new packets to be provided by the distributor. * - * NOTE: after calling this function, rte_distributor_poll_pkt_burst() should - * be used to poll for the packet requested. The rte_distributor_get_pkt_burst() - * API should *not* be used to try and retrieve the new packet. + * NOTE: after calling this function, rte_distributor_poll_pkt() should + * be used to poll for the packets requested. The rte_distributor_get_pkt() + * API should *not* be used to try and retrieve the new packets. * * @param d * The distributor instance to be used @@ -213,9 +213,9 @@ rte_distributor_request_pkt(struct rte_distributor *d, unsigned int count); /** - * API called by a worker to check for a new packet that was previously + * API called by a worker to check for new packets that were previously * requested by a call to rte_distributor_request_pkt(). It does not wait - * for the new packet to be available, but returns NULL if the request has + * for the new packets to be available, but returns if the request has * not yet been fulfilled by the distributor. * * @param d @@ -227,8 +227,9 @@ rte_distributor_request_pkt(struct rte_distributor *d, * The array of mbufs being given to the worker * * @return - * The number of packets being given to the worker thread, zero if no - * packet is yet available. + * The number of packets being given to the worker thread, + * -1 if no packets are yet available (burst API - RTE_DIST_ALG_BURST) + * 0 if no packets are yet available (legacy single API - RTE_DIST_ALG_SINGLE) */ int rte_distributor_poll_pkt(struct rte_distributor *d, -- 2.20.1 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2020-10-28 10:35:17.626301998 +0000 +++ 0191-distributor-fix-API-documentation.patch 2020-10-28 10:35:11.800834381 +0000 @@ -1,15 +1,16 @@ -From ed4be82d9e645c86ccd16938bdb200cdecaa2906 Mon Sep 17 00:00:00 2001 +From 7c3f944d2fec17fad74d96e36fa93dcd6d0aad84 Mon Sep 17 00:00:00 2001 From: Lukasz Wojciechowski Date: Sat, 17 Oct 2020 05:06:54 +0200 Subject: [PATCH] distributor: fix API documentation +[ upstream commit ed4be82d9e645c86ccd16938bdb200cdecaa2906 ] + After introducing burst API there were some artefacts in the API documentation from legacy single API. Also the rte_distributor_poll_pkt() function return values mismatched the implementation. Fixes: c0de0eb82e40 ("distributor: switch over to new API") -Cc: stable@dpdk.org Signed-off-by: Lukasz Wojciechowski Acked-by: David Hunt