DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net,
	Bruce Richardson <bruce.richardson@intel.com>,
	i.dyukov@samsung.com
Subject: [dpdk-dev] [PATCH v2 5/6] ethdev: fix mis-named parameter
Date: Tue, 29 Sep 2020 17:55:01 +0100	[thread overview]
Message-ID: <20200929165502.336919-6-bruce.richardson@intel.com> (raw)
In-Reply-To: <20200929165502.336919-1-bruce.richardson@intel.com>

The parameter to rte_eth_link_speed_to_str was called "speed_link" in the
function prototype in the header file, but "link_speed" everywhere else.
This showed up as warnings when building the API docs, due to missing and
undocumented parameters from doxygen's viewpoint.

Rename the prototype value to the correct name to fix these issues.

Fixes: fbf931c9c392 ("ethdev: format link status text")
Cc: i.dyukov@samsung.com

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/librte_ethdev/rte_ethdev.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 645a18664..9759f1330 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -2452,7 +2452,7 @@ int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
  *   No free is required.
  */
 __rte_experimental
-const char *rte_eth_link_speed_to_str(uint32_t speed_link);
+const char *rte_eth_link_speed_to_str(uint32_t link_speed);
 
 /**
  * @warning
-- 
2.25.1


  parent reply	other threads:[~2020-09-29 16:56 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-29 15:34 [dpdk-dev] [PATCH 0/4] improve output when building docs Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 1/4] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 15:55   ` Thomas Monjalon
2020-09-29 16:23     ` Bruce Richardson
2020-09-29 16:31       ` Thomas Monjalon
2020-09-29 16:40         ` Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 2/4] doc/api: align output folder with sphinx guides Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 3/4] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 15:34 ` [dpdk-dev] [PATCH 4/4] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:54 ` [dpdk-dev] [PATCH v2 0/6] improve building docs Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 1/6] doc/api: hide verbose doxygen standard output Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 2/6] doc/api: align output folder with sphinx guides Bruce Richardson
2020-09-29 16:54   ` [dpdk-dev] [PATCH v2 3/6] doc/api: put output log file in build directory Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 4/6] doc/guides: suppress printing out standard output Bruce Richardson
2020-09-29 16:55   ` Bruce Richardson [this message]
2020-09-29 17:34     ` [dpdk-dev] [PATCH v2 5/6] ethdev: fix mis-named parameter David Marchand
2020-09-29 17:34     ` Thomas Monjalon
2020-09-30  9:01       ` Bruce Richardson
2020-09-29 16:55   ` [dpdk-dev] [PATCH v2 6/6] doc/api: make doc warnings errors when werror option set Bruce Richardson
2020-09-29 17:33     ` Thomas Monjalon
2020-09-30 14:32   ` [dpdk-dev] [PATCH v2 0/6] improve building docs Thomas Monjalon

Reply instructions:

You may reply publicly 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=20200929165502.336919-6-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=i.dyukov@samsung.com \
    --cc=thomas@monjalon.net \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).