From patchwork Tue Sep 29 12:12:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Marchand X-Patchwork-Id: 79197 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B7B81A04C0; Tue, 29 Sep 2020 14:12:40 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7DAFE1D6A5; Tue, 29 Sep 2020 14:12:38 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by dpdk.org (Postfix) with ESMTP id BFE911D693 for ; Tue, 29 Sep 2020 14:12:35 +0200 (CEST) Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1601381554; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Qm7LHP9ElaVBEpRBAth0A2aTlAkH2XXb2NRX2U6z6Dc=; b=LgiU2hivMDM69oG+G17Ls0Q+H0qGw5ldGYLNBlOWih9j0B+nldCnE+iN+IfwhhDwV+4qOT iILP3xnCd3JWanCq+JJpLwCI32eacXAaYMglEqVL69g1uUDlrpfJcCulmjGndbiYYKxvCv mVx308TyTPD/Rl4NIFffrlbarPgxomo= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-361-r8TipABxNaSBM_LM2LOang-1; Tue, 29 Sep 2020 08:12:30 -0400 X-MC-Unique: r8TipABxNaSBM_LM2LOang-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 474F88030B3; Tue, 29 Sep 2020 12:12:28 +0000 (UTC) Received: from dmarchan.remote.csb (unknown [10.40.192.140]) by smtp.corp.redhat.com (Postfix) with ESMTP id CF4A45D9E4; Tue, 29 Sep 2020 12:12:25 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: Thomas Monjalon , Ferruh Yigit , Andrew Rybchenko , =?utf-8?q?Morten_Br=C3=B8rup?= , Ivan Dyukov Date: Tue, 29 Sep 2020 14:12:22 +0200 Message-Id: <20200929121222.12954-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=david.marchand@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Subject: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" When generating the documentation, a new warning can be seen: .../dpdk/lib/librte_ethdev/rte_ethdev.h:2441: warning: argument 'link_speed' of command @param is not found in the argument list of rte_eth_link_speed_to_str(uint32_t speed_link) .../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following parameters of rte_eth_link_speed_to_str(uint32_t speed_link) are not documented: parameter 'speed_link' Align the function prototype to its doxygen description. Fixes: fbf931c9c392 ("ethdev: format link status text") Signed-off-by: David Marchand Acked-by: Andrew Rybchenko --- 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 645a18664d..9759f13303 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