[PATCH] drivers/pci/setup-irq.c: Fix up comments.

[PATCH] drivers/pci/setup-irq.c: Fix up comments.

[Pranay Sanghai]

Make comments follow multi-line comment conventions. No functional change intended.

Signed-off-by: Pranay Sanghai <pranaysanghai@gmail.com>

---
 drivers/pci/setup-irq.c | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/drivers/pci/setup-irq.c b/drivers/pci/setup-irq.c
index 7129494754dd..ed628771250b 100644
--- a/drivers/pci/setup-irq.c
+++ b/drivers/pci/setup-irq.c
@@ -28,12 +28,13 @@ void pci_assign_irq(struct pci_dev *dev)
 		return;
 	}
 
-	/* If this device is not on the primary bus, we need to figure out
-	   which interrupt pin it will come in on.   We know which slot it
-	   will come in on 'cos that slot is where the bridge is.   Each
-	   time the interrupt line passes through a PCI-PCI bridge we must
-	   apply the swizzle function.  */
-
+	/*
+	 * If this device is not on the primary bus, we need to figure out
+	 * which interrupt pin it will come in on. We know which slot it
+	 * will come in on 'cos that slot is where the bridge is. Each
+	 * time the interrupt line passes through a PCI-PCI bridge we must
+	 * apply the swizzle function.
+	 */
 	pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
 	/* Cope with illegal. */
 	if (pin > 4)
@@ -56,7 +57,9 @@ void pci_assign_irq(struct pci_dev *dev)
 
 	pci_dbg(dev, "assign IRQ: got %d\n", dev->irq);
 
-	/* Always tell the device, so the driver knows what is
-	   the real IRQ to use; the device does not use it. */
+	/*
+	 * Always tell the device, so the driver knows what is
+	 * the real IRQ to use; the device does not use it.
+	 */
 	pci_write_config_byte(dev, PCI_INTERRUPT_LINE, irq);
 }
-- 
2.33.0

Re: [PATCH] drivers/pci/setup-irq.c: Fix up comments.

[Bjorn Helgaas]

On Sat, Sep 18, 2021 at 01:18:02PM -0700, Pranay Sanghai wrote:
> Make comments follow multi-line comment conventions. No functional change intended.
> 
> Signed-off-by: Pranay Sanghai <pranaysanghai@gmail.com>

Applied to pci/misc for v5.16, with the changes below, thanks!

  - Updated subject line to follow the convention (see "git log
    --oneline drivers/pci/setup-irq.c").

  - Rewrapped commit log to fit in 75 columns so it fits in 80 when
    "git log" indents it.

  - Rewrapped comments to fill 80 columns like the rest of the file.

  - Replaced "'cos" with "because".

> ---
>  drivers/pci/setup-irq.c | 19 +++++++++++--------
>  1 file changed, 11 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/pci/setup-irq.c b/drivers/pci/setup-irq.c
> index 7129494754dd..ed628771250b 100644
> --- a/drivers/pci/setup-irq.c
> +++ b/drivers/pci/setup-irq.c
> @@ -28,12 +28,13 @@ void pci_assign_irq(struct pci_dev *dev)
>  		return;
>  	}
>  
> -	/* If this device is not on the primary bus, we need to figure out
> -	   which interrupt pin it will come in on.   We know which slot it
> -	   will come in on 'cos that slot is where the bridge is.   Each
> -	   time the interrupt line passes through a PCI-PCI bridge we must
> -	   apply the swizzle function.  */
> -
> +	/*
> +	 * If this device is not on the primary bus, we need to figure out
> +	 * which interrupt pin it will come in on. We know which slot it
> +	 * will come in on 'cos that slot is where the bridge is. Each
> +	 * time the interrupt line passes through a PCI-PCI bridge we must
> +	 * apply the swizzle function.
> +	 */
>  	pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
>  	/* Cope with illegal. */
>  	if (pin > 4)
> @@ -56,7 +57,9 @@ void pci_assign_irq(struct pci_dev *dev)
>  
>  	pci_dbg(dev, "assign IRQ: got %d\n", dev->irq);
>  
> -	/* Always tell the device, so the driver knows what is
> -	   the real IRQ to use; the device does not use it. */
> +	/*
> +	 * Always tell the device, so the driver knows what is
> +	 * the real IRQ to use; the device does not use it.
> +	 */
>  	pci_write_config_byte(dev, PCI_INTERRUPT_LINE, irq);
>  }
> -- 
> 2.33.0
>