bus/pci: fix comment explaining device naming

Message ID 20201116101212.405300-1-grive@u256.net (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series bus/pci: fix comment explaining device naming |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Gaëtan Rivet Nov. 16, 2020, 10:12 a.m. UTC
  The original triple negative was hard to read and the attempt
to improve the formulation was commendable, unfortunately the new
comment is the inverse of correct.

Fixes: a65a34a85ebf ("eal: replace usage of blacklist/whitelist in enums")
Cc: stephen@networkplumber.org
Signed-off-by: Gaetan Rivet <grive@u256.net>
---

No Cc:stable as it was not yet released.

 drivers/bus/pci/pci_common.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
  

Comments

Luca Boccassi Nov. 16, 2020, 11:56 a.m. UTC | #1
On Mon, 2020-11-16 at 11:12 +0100, Gaetan Rivet wrote:
> The original triple negative was hard to read and the attempt
> to improve the formulation was commendable, unfortunately the new
> comment is the inverse of correct.
> 
> Fixes: a65a34a85ebf ("eal: replace usage of blacklist/whitelist in enums")
> Cc: stephen@networkplumber.org
> Signed-off-by: Gaetan Rivet <grive@u256.net>
> ---
> 
> No Cc:stable as it was not yet released.
> 
>  drivers/bus/pci/pci_common.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c
> index b24c069713..d55e5a38cf 100644
> --- a/drivers/bus/pci/pci_common.c
> +++ b/drivers/bus/pci/pci_common.c
> @@ -68,7 +68,9 @@ pci_name_set(struct rte_pci_device *dev)
>  	devargs = pci_devargs_lookup(&dev->addr);
>  	dev->device.devargs = devargs;
>  
> -	/* If the device is blocked, no rte_devargs exists for it. */
> +	/* When using a block-list, only blocked devices will have
> +	 * an rte_devargs. Allowed devices won't have one.
> +	 */
>  	if (devargs != NULL)
>  		/* If an rte_devargs exists, the generic rte_device uses the
>  		 * given name as its name.

Acked-by: Luca Boccassi <bluca@debian.org>

Thanks for fixing my mistake - at least it became readable enough to
understand it was the other way around :-)
  
David Marchand Nov. 18, 2020, 10:46 a.m. UTC | #2
On Mon, Nov 16, 2020 at 11:12 AM Gaetan Rivet <grive@u256.net> wrote:
>
> The original triple negative was hard to read and the attempt
> to improve the formulation was commendable, unfortunately the new
> comment is the inverse of correct.
>
> Fixes: a65a34a85ebf ("eal: replace usage of blacklist/whitelist in enums")
> Cc: stephen@networkplumber.org
> Signed-off-by: Gaetan Rivet <grive@u256.net>
> ---
>
> No Cc:stable as it was not yet released.
>
>  drivers/bus/pci/pci_common.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c
> index b24c069713..d55e5a38cf 100644
> --- a/drivers/bus/pci/pci_common.c
> +++ b/drivers/bus/pci/pci_common.c
> @@ -68,7 +68,9 @@ pci_name_set(struct rte_pci_device *dev)
>         devargs = pci_devargs_lookup(&dev->addr);
>         dev->device.devargs = devargs;
>
> -       /* If the device is blocked, no rte_devargs exists for it. */
> +       /* When using a block-list, only blocked devices will have

Nit: I don't think we need a -, I would go with blocklist.

> +        * an rte_devargs. Allowed devices won't have one.
> +        */
>         if (devargs != NULL)
>                 /* If an rte_devargs exists, the generic rte_device uses the
>                  * given name as its name.
> --
> 2.29.2
>

Reviewed-by: David Marchand <david.marchand@redhat.com>
  
David Marchand Nov. 20, 2020, 9:02 a.m. UTC | #3
On Mon, Nov 16, 2020 at 11:12 AM Gaetan Rivet <grive@u256.net> wrote:
>
> The original triple negative was hard to read and the attempt
> to improve the formulation was commendable, unfortunately the new
> comment is the inverse of correct.
>
> Fixes: a65a34a85ebf ("eal: replace usage of blacklist/whitelist in enums")

Reported-by: David Marchand <david.marchand@redhat.com>
> Signed-off-by: Gaetan Rivet <grive@u256.net>
Acked-by: Luca Boccassi <bluca@debian.org>
Reviewed-by: David Marchand <david.marchand@redhat.com>

Thanks Gaëtan, applied.
  

Patch

diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c
index b24c069713..d55e5a38cf 100644
--- a/drivers/bus/pci/pci_common.c
+++ b/drivers/bus/pci/pci_common.c
@@ -68,7 +68,9 @@  pci_name_set(struct rte_pci_device *dev)
 	devargs = pci_devargs_lookup(&dev->addr);
 	dev->device.devargs = devargs;
 
-	/* If the device is blocked, no rte_devargs exists for it. */
+	/* When using a block-list, only blocked devices will have
+	 * an rte_devargs. Allowed devices won't have one.
+	 */
 	if (devargs != NULL)
 		/* If an rte_devargs exists, the generic rte_device uses the
 		 * given name as its name.