[dpdk-dev] [PATCH 1/2] remove references to private PCI probe function

[Gaëtan Rivet]

Hello David,

On 06/05/20 14:43 +0200, David Marchand wrote:
> rte_pci_probe() is private to the PCI bus.
> Clean the remaining references in the documentation and comments.
> 
> Fixes: c752998b5e2e ("pci: introduce library and driver")
> Cc: stable at dpdk.org
> 
> Signed-off-by: David Marchand <david.marchand at redhat.com>
> ---
>  doc/guides/sample_app_ug/l2_forward_event.rst        |  8 --------
>  doc/guides/sample_app_ug/l2_forward_real_virtual.rst |  9 ---------
>  doc/guides/sample_app_ug/link_status_intr.rst        |  7 -------
>  doc/guides/sample_app_ug/multi_process.rst           |  2 +-
>  drivers/bus/pci/pci_common.c                         |  6 +++---
>  drivers/bus/pci/private.h                            | 10 ----------
>  drivers/net/virtio/virtio_user_ethdev.c              |  2 +-
>  7 files changed, 5 insertions(+), 39 deletions(-)
> 
> diff --git a/doc/guides/sample_app_ug/l2_forward_event.rst b/doc/guides/sample_app_ug/l2_forward_event.rst
> index 8bdf352c4e..d536eee819 100644
> --- a/doc/guides/sample_app_ug/l2_forward_event.rst
> +++ b/doc/guides/sample_app_ug/l2_forward_event.rst
> @@ -204,9 +204,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
>  
>  .. code-block:: c
>  
> -    if (rte_pci_probe() < 0)
> -        rte_panic("Cannot probe PCI\n");
> -
>      /* reset l2fwd_dst_ports */
>  
>      for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
> @@ -236,11 +233,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
>          rte_eth_dev_info_get((uint8_t) portid, &dev_info);
>      }
>  
> -Observe that:
> -
> -*   rte_pci_probe() parses the devices on the PCI bus and initializes recognized
> -    devices.
> -

Reading the docs overall, what needed to be covered by referencing
rte_pci_probe() here should be covered by the reference to
rte_eal_init() earlier.

So simply removing rte_pci_probe() line in these docs seems ok.

LGTM,

Reviewed-by: Gaetan Rivet <grive at u256.net>


-- 
Gaëtan