pci: fix comment referencing renamed function

Message ID 20230530160215.2314373-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series pci: fix comment referencing renamed function |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Thomas Monjalon May 30, 2023, 4:02 p.m. UTC
  When renaming functions eal_parse_pci_*,
a referencing comment was missed in the function rte_pci_device_name().

Fixes: ca52fccbb3b9 ("pci: remove deprecated functions")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/pci/rte_pci.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
  

Comments

Chenbo Xia May 31, 2023, 6:02 a.m. UTC | #1
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Wednesday, May 31, 2023 12:02 AM
> To: dev@dpdk.org
> Cc: stable@dpdk.org; Gaetan Rivet <grive@u256.net>; David Marchand
> <david.marchand@redhat.com>
> Subject: [PATCH] pci: fix comment referencing renamed function
> 
> When renaming functions eal_parse_pci_*,
> a referencing comment was missed in the function rte_pci_device_name().
> 
> Fixes: ca52fccbb3b9 ("pci: remove deprecated functions")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  lib/pci/rte_pci.h | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/lib/pci/rte_pci.h b/lib/pci/rte_pci.h
> index 5088157e74..aab761b918 100644
> --- a/lib/pci/rte_pci.h
> +++ b/lib/pci/rte_pci.h
> @@ -104,8 +104,7 @@ struct rte_pci_addr {
> 
>  /**
>   * Utility function to write a pci device name, this device name can
> later be
> - * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
> - * BDF helpers.
> + * used to retrieve the corresponding rte_pci_addr using
> rte_pci_addr_parse().
>   *
>   * @param addr
>   *	The PCI Bus-Device-Function address
> --
> 2.40.1

Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>
  
Thomas Monjalon June 6, 2023, 2:39 p.m. UTC | #2
31/05/2023 08:02, Xia, Chenbo:
> > -----Original Message-----
> > From: Thomas Monjalon <thomas@monjalon.net>
> > Sent: Wednesday, May 31, 2023 12:02 AM
> > To: dev@dpdk.org
> > Cc: stable@dpdk.org; Gaetan Rivet <grive@u256.net>; David Marchand
> > <david.marchand@redhat.com>
> > Subject: [PATCH] pci: fix comment referencing renamed function
> > 
> > When renaming functions eal_parse_pci_*,
> > a referencing comment was missed in the function rte_pci_device_name().
> > 
> > Fixes: ca52fccbb3b9 ("pci: remove deprecated functions")
> > Cc: stable@dpdk.org
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>

Applied
  

Patch

diff --git a/lib/pci/rte_pci.h b/lib/pci/rte_pci.h
index 5088157e74..aab761b918 100644
--- a/lib/pci/rte_pci.h
+++ b/lib/pci/rte_pci.h
@@ -104,8 +104,7 @@  struct rte_pci_addr {
 
 /**
  * Utility function to write a pci device name, this device name can later be
- * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
- * BDF helpers.
+ * used to retrieve the corresponding rte_pci_addr using rte_pci_addr_parse().
  *
  * @param addr
  *	The PCI Bus-Device-Function address