patches for DPDK stable branches
 help / color / Atom feed
From: Kevin Traynor <ktraynor@redhat.com>
To: Michal Krawczyk <mk@semihalf.com>
Cc: Igor Chauskin <igorch@amazon.com>,
	Guy Tzalik <gtzalik@amazon.com>, dpdk stable <stable@dpdk.org>
Subject: [dpdk-stable] patch 'net/ena/base: fix documentation of functions' has been queued to LTS release 18.11.9
Date: Thu, 28 May 2020 17:22:53 +0100
Message-ID: <20200528162322.7863-66-ktraynor@redhat.com> (raw)
In-Reply-To: <20200528162322.7863-1-ktraynor@redhat.com>

Hi,

FYI, your patch has been queued to LTS release 18.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 06/03/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.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/a1c41ac2eba79d42bba4c52f33126b2a45b91cc2

Thanks.

Kevin.

---
From a1c41ac2eba79d42bba4c52f33126b2a45b91cc2 Mon Sep 17 00:00:00 2001
From: Michal Krawczyk <mk@semihalf.com>
Date: Wed, 8 Apr 2020 10:29:01 +0200
Subject: [PATCH] net/ena/base: fix documentation of functions

[ upstream commit b118993abd4cae7af3f8a66e0ad4fda1bee84c09 ]

The documentation format was aligned and few typos were fixed.

Fixes: 99ecfbf845b3 ("ena: import communication layer")

Signed-off-by: Michal Krawczyk <mk@semihalf.com>
Reviewed-by: Igor Chauskin <igorch@amazon.com>
Reviewed-by: Guy Tzalik <gtzalik@amazon.com>
---
 drivers/net/ena/base/ena_com.h | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/drivers/net/ena/base/ena_com.h b/drivers/net/ena/base/ena_com.h
index f58cd86a87..2e80ad563f 100644
--- a/drivers/net/ena/base/ena_com.h
+++ b/drivers/net/ena/base/ena_com.h
@@ -381,5 +381,5 @@ extern "C" {
 int ena_com_mmio_reg_read_request_init(struct ena_com_dev *ena_dev);
 
-/* ena_com_set_mmio_read_mode - Enable/disable the mmio reg read mechanism
+/* ena_com_set_mmio_read_mode - Enable/disable the indirect mmio reg read mechanism
  * @ena_dev: ENA communication layer struct
  * @readless_supported: readless mode (enable/disable)
@@ -507,5 +507,5 @@ bool ena_com_get_ena_admin_polling_mode(struct ena_com_dev *ena_dev);
  * @ena_dev: ENA communication layer struct
  *
- * This method go over the admin completion queue and wake up all the pending
+ * This method goes over the admin completion queue and wakes up all the pending
  * threads that wait on the commands wait event.
  *
@@ -517,5 +517,5 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
  * @ena_dev: ENA communication layer struct
  *
- * This method go over the async event notification queue and call the proper
+ * This method goes over the async event notification queue and calls the proper
  * aenq handler.
  */
@@ -534,5 +534,5 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
  * @ena_dev: ENA communication layer struct
  *
- * This method wait until all the outstanding admin commands will be completed.
+ * This method waits until all the outstanding admin commands are completed.
  */
 void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
@@ -541,5 +541,5 @@ void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
  * @ena_dev: ENA communication layer struct
  *
- * This method validate the device parameters are the same as the saved
+ * This method verifies the device parameters are the same as the saved
  * parameters in ena_dev.
  * This method is useful after device reset, to validate the device mac address
@@ -718,5 +718,5 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
  * Retrieve the hash control from the device.
  *
- * @note, If the caller called ena_com_fill_hash_ctrl but didn't flash
+ * @note: If the caller called ena_com_fill_hash_ctrl but didn't flash
  * it to the device, the new configuration will be lost.
  *
@@ -770,5 +770,5 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
  * Retrieve the RSS indirection table from the device.
  *
- * @note: If the caller called ena_com_indirect_table_fill_entry but didn't flash
+ * @note: If the caller called ena_com_indirect_table_fill_entry but didn't flush
  * it to the device, the new configuration will be lost.
  *
@@ -796,5 +796,5 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
  * @ena_dev: ENA communication layer struct
  *
- * Free the allocate debug area.
+ * Free the allocated debug area.
  */
 void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
@@ -803,5 +803,5 @@ void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
  * @ena_dev: ENA communication layer struct
  *
- * Free the allocate host info.
+ * Free the allocated host info.
  */
 void ena_com_delete_host_info(struct ena_com_dev *ena_dev);
@@ -844,7 +844,7 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
  * @cmd_comp_size: command completion size.
 
- * Submit an admin command and then wait until the device will return a
+ * Submit an admin command and then wait until the device returns a
  * completion.
- * The completion will be copyed into cmd_comp.
+ * The completion will be copied into cmd_comp.
  *
  * @return - 0 on success, negative value on failure.
@@ -1028,5 +1028,5 @@ static inline void ena_com_calculate_interrupt_delay(struct ena_com_dev *ena_dev
  * @rx_delay_interval: Rx interval in usecs
  * @tx_delay_interval: Tx interval in usecs
- * @unmask: unask enable/disable
+ * @unmask: unmask enable/disable
  *
  * Prepare interrupt update register with the supplied parameters.
-- 
2.21.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-05-28 17:13:02.515704682 +0100
+++ 0066-net-ena-base-fix-documentation-of-functions.patch	2020-05-28 17:12:59.144555427 +0100
@@ -1 +1 @@
-From b118993abd4cae7af3f8a66e0ad4fda1bee84c09 Mon Sep 17 00:00:00 2001
+From a1c41ac2eba79d42bba4c52f33126b2a45b91cc2 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit b118993abd4cae7af3f8a66e0ad4fda1bee84c09 ]
+
@@ -18 +20 @@
-index 07f63f44af..6c9943df79 100644
+index f58cd86a87..2e80ad563f 100644
@@ -21 +23 @@
-@@ -371,5 +371,5 @@ extern "C" {
+@@ -381,5 +381,5 @@ extern "C" {
@@ -28 +30 @@
-@@ -505,5 +505,5 @@ void ena_com_set_admin_auto_polling_mode(struct ena_com_dev *ena_dev,
+@@ -507,5 +507,5 @@ bool ena_com_get_ena_admin_polling_mode(struct ena_com_dev *ena_dev);
@@ -35 +37 @@
-@@ -515,5 +515,5 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
+@@ -517,5 +517,5 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
@@ -42 +44 @@
-@@ -532,5 +532,5 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
+@@ -534,5 +534,5 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
@@ -49 +51 @@
-@@ -539,5 +539,5 @@ void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
+@@ -541,5 +541,5 @@ void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
@@ -56 +58 @@
-@@ -716,5 +716,5 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
+@@ -718,5 +718,5 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
@@ -63 +65 @@
-@@ -768,5 +768,5 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
+@@ -770,5 +770,5 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
@@ -70 +72 @@
-@@ -794,5 +794,5 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
+@@ -796,5 +796,5 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
@@ -77 +79 @@
-@@ -801,5 +801,5 @@ void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
+@@ -803,5 +803,5 @@ void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
@@ -84 +86 @@
-@@ -842,7 +842,7 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
+@@ -844,7 +844,7 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
@@ -94 +96 @@
-@@ -933,5 +933,5 @@ static inline void ena_com_disable_adaptive_moderation(struct ena_com_dev *ena_d
+@@ -1028,5 +1028,5 @@ static inline void ena_com_calculate_interrupt_delay(struct ena_com_dev *ena_dev


  parent reply index

Thread overview: 97+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-28 16:21 [dpdk-stable] patch 'app/pipeline: fix build with gcc 10' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'examples/eventdev: " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'drivers: add crypto as dependency for event drivers' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'eal: fix log message print for regex' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'eal/arm64: fix precise TSC' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'mem: mark pages as not accessed when reserving VA' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'service: fix crash on exit' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'pci: fix build on ppc' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'net/i40e: fix X722 performance' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'doc: fix number of failsafe sub-devices' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'net/sfc: fix reported promiscuous/multicast mode' " Kevin Traynor
2020-05-28 16:21 ` [dpdk-stable] patch 'net/sfc: fix initialization error path' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/sfc: fix Rx queue start failure " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/mlx5: fix mask used for IPv6 item validation' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'ethdev: fix spelling' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/sfc/base: reduce filter priorities to implemented only' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/sfc/base: reject automatic filter creation by users' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/sfc/base: refactor filter lookup loop in EF10' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/sfc/base: handle manual and auto filter clashes " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/mlx5: fix CVLAN tag set in IP item translation' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'contigmem: cleanup properly when load fails' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'devtools: fix symbol map change check' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'test: skip some subtests in no-huge mode' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'test/kvargs: fix to consider empty elements as valid' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'test/kvargs: fix invalid cases check' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'kvargs: fix buffer overflow when parsing list' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'bus/pci: fix devargs on probing again' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'common/qat: fix GEN3 marketing name' " Kevin Traynor
2020-06-04 16:29   ` Trahe, Fiona
2020-06-04 16:36     ` Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'event/dsw: remove redundant control ring poll' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'event/dsw: remove unnecessary read barrier' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'doc: fix sphinx compatibility' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'log: fix level picked with globbing on type register' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'doc: fix matrix CSS for recent sphinx' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'vfio: fix race condition with sysfs' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'vfio: fix use after free with multiprocess' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'drivers: fix log type variables for -fno-common' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'drivers/crypto: " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'test/crypto: fix flag check' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'crypto/openssl: fix out-of-place encryption' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'security: fix verification of parameters' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'security: fix return types in documentation' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'security: fix session counter' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'test: remove redundant macro' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/mlx5: fix validation of VXLAN/VXLAN-GPE specs' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'examples/vmdq: fix output of pools/queues' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/mvneta: do not use PMD log type' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/virtio: " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/tap: " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/bnxt: " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/dpaa: use dynamic " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/thunderx: " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/tap: remove unused assert' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/octeontx: fix meson build for disabled drivers' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: propagate descriptor limits from VF' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: handle Rx packets during multi-channel setup' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: split send buffers from Tx descriptors' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: fix memory free on device close' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: remove process event optimization' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: handle Tx completions based on burst size' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/netvsc: avoid possible live lock' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'ethdev: fix build when vtune profiling is on' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'examples/vmdq: fix RSS configuration' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena/base: make allocation macros thread-safe' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena/base: prevent allocation of zero sized memory' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena/base: fix testing for supported hash function' " Kevin Traynor
2020-05-28 16:22 ` Kevin Traynor [this message]
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena/base: fix indentation in CQ polling' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena/base: fix indentation of multiple defines' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/ena: set IO ring size to valid value' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/null: fix secondary burst function selection' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'net/null: remove redundant check' " Kevin Traynor
2020-05-28 16:22 ` [dpdk-stable] patch 'vhost/crypto: add missing user protocol flag' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/vhost: fix potential memory leak on close' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/virtio: fix outdated comment' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'vhost: remove unused variable' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'vhost: make IOTLB cache name unique among processes' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/mlx4: fix build with -fno-common' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/i40e: relax barrier in Tx for NEON' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix mbuf and mem leak during queue release' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix check for mbuf number of segment' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix file close on remove' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix fd leak on creation failure' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix unexpected link handler' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/virtio-user: fix devargs parsing' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/tap: fix queues fd check before close' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/iavf: fix stats query error code' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'net/bnxt: fix VLAN add when port is stopped' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'security: fix crash at accessing non-implemented ops' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'lpm6: fix size of tbl8 group' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'lpm6: fix comments spelling' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'eal: " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'fix various typos found by Lintian' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'app: fix usage help of options separated by dashes' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'usertools: check for pci.ids in /usr/share/misc' " Kevin Traynor
2020-05-28 16:23 ` [dpdk-stable] patch 'bus/pci: fix UIO resource access from secondary process' " Kevin Traynor

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200528162322.7863-66-ktraynor@redhat.com \
    --to=ktraynor@redhat.com \
    --cc=gtzalik@amazon.com \
    --cc=igorch@amazon.com \
    --cc=mk@semihalf.com \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

patches for DPDK stable branches

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/ public-inbox