diff mbox series

[2/4] bnx2x: remove profanity

Message ID 20180725182019.31518-3-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series small cleanups |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Stephen Hemminger July 25, 2018, 6:20 p.m. UTC 
  No need for profanity in comments.

Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
---
 drivers/net/bnx2x/elink.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Thomas Monjalon Sept. 18, 2018, 9:40 a.m. UTC | #1 
25/07/2018 20:20, Stephen Hemminger:
> No need for profanity in comments.
> 
> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
> ---
>  drivers/net/bnx2x/elink.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
> index 34a29373af3b..08fe817720a1 100644
> --- a/drivers/net/bnx2x/elink.c
> +++ b/drivers/net/bnx2x/elink.c
> @@ -3993,11 +3993,11 @@ static elink_status_t elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
>  			   PORT_HW_CFG_E3_MOD_ABS_MASK) >>
>  		    PORT_HW_CFG_E3_MOD_ABS_SHIFT;
>  
> -		/* Should not happen. This function called upon interrupt
> +		/*
> +		 * Should not happen. This function called upon interrupt
>  		 * triggered by GPIO ( since EPIO can only generate interrupts
>  		 * to MCP).
>  		 * So if this function was called and none of the GPIOs was set,
> -		 * it means the shit hit the fan.
>  		 */

It makes the comment ends with a comma, like the end is missing.
Stephen Hemminger Sept. 18, 2018, 3:07 p.m. UTC | #2 
On Tue, 18 Sep 2018 11:40:28 +0200
Thomas Monjalon <thomas@monjalon.net> wrote:

> 25/07/2018 20:20, Stephen Hemminger:
> > No need for profanity in comments.
> > 
> > Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
> > ---
> >  drivers/net/bnx2x/elink.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
> > index 34a29373af3b..08fe817720a1 100644
> > --- a/drivers/net/bnx2x/elink.c
> > +++ b/drivers/net/bnx2x/elink.c
> > @@ -3993,11 +3993,11 @@ static elink_status_t elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
> >  			   PORT_HW_CFG_E3_MOD_ABS_MASK) >>
> >  		    PORT_HW_CFG_E3_MOD_ABS_SHIFT;
> >  
> > -		/* Should not happen. This function called upon interrupt
> > +		/*
> > +		 * Should not happen. This function called upon interrupt
> >  		 * triggered by GPIO ( since EPIO can only generate interrupts
> >  		 * to MCP).
> >  		 * So if this function was called and none of the GPIOs was set,
> > -		 * it means the shit hit the fan.
> >  		 */  
> 
> It makes the comment ends with a comma, like the end is missing.
> 
> 
> 

Yes, better language would be.
		/* This should not happen since this function is called
		 * from interrupt triggered by GPI ..
Mody, Rasesh Sept. 19, 2018, 4:40 p.m. UTC | #3 
>From: Stephen Hemminger <stephen@networkplumber.org>
>Sent: Tuesday, September 18, 2018 8:07 AM
>
>On Tue, 18 Sep 2018 11:40:28 +0200
>Thomas Monjalon <thomas@monjalon.net> wrote:
>
>> 25/07/2018 20:20, Stephen Hemminger:
>> > No need for profanity in comments.
>> >
>> > Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
>> > ---
>> >  drivers/net/bnx2x/elink.c | 4 ++--
>> >  1 file changed, 2 insertions(+), 2 deletions(-)
>> >
>> > diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
>> > index 34a29373af3b..08fe817720a1 100644
>> > --- a/drivers/net/bnx2x/elink.c
>> > +++ b/drivers/net/bnx2x/elink.c
>> > @@ -3993,11 +3993,11 @@ static elink_status_t
>elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
>> >                        PORT_HW_CFG_E3_MOD_ABS_MASK) >>
>> >                 PORT_HW_CFG_E3_MOD_ABS_SHIFT;
>> >
>> > -           /* Should not happen. This function called upon interrupt
>> > +           /*
>> > +            * Should not happen. This function called upon
>> > + interrupt
>> >              * triggered by GPIO ( since EPIO can only generate interrupts
>> >              * to MCP).
>> >              * So if this function was called and none of the GPIOs was set,
>> > -            * it means the shit hit the fan.
>> >              */
>>
>> It makes the comment ends with a comma, like the end is missing.
>>
>>
>>
>
>Yes, better language would be.
>                /* This should not happen since this function is called
>                 * from interrupt triggered by GPI ..

+1
I've re-worded the last bit.

	/* This should not happen since this function is called
	 * from interrupt triggered by GPIO (since EPIO can only
	 * generate interrupts to MCP).
	 * So if this function was called and none of the GPIOs was set,
	 * it means something disastrous has already happened.
	 */

Thanks!
-Rasesh
Ferruh Yigit Oct. 16, 2018, 2:45 p.m. UTC | #4 
On 9/19/2018 5:40 PM, Mody, Rasesh wrote:
>> From: Stephen Hemminger <stephen@networkplumber.org>
>> Sent: Tuesday, September 18, 2018 8:07 AM
>>
>> On Tue, 18 Sep 2018 11:40:28 +0200
>> Thomas Monjalon <thomas@monjalon.net> wrote:
>>
>>> 25/07/2018 20:20, Stephen Hemminger:
>>>> No need for profanity in comments.
>>>>
>>>> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
>>>> ---
>>>>  drivers/net/bnx2x/elink.c | 4 ++--
>>>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
>>>> index 34a29373af3b..08fe817720a1 100644
>>>> --- a/drivers/net/bnx2x/elink.c
>>>> +++ b/drivers/net/bnx2x/elink.c
>>>> @@ -3993,11 +3993,11 @@ static elink_status_t
>> elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
>>>>                        PORT_HW_CFG_E3_MOD_ABS_MASK) >>
>>>>                 PORT_HW_CFG_E3_MOD_ABS_SHIFT;
>>>>
>>>> -           /* Should not happen. This function called upon interrupt
>>>> +           /*
>>>> +            * Should not happen. This function called upon
>>>> + interrupt
>>>>              * triggered by GPIO ( since EPIO can only generate interrupts
>>>>              * to MCP).
>>>>              * So if this function was called and none of the GPIOs was set,
>>>> -            * it means the shit hit the fan.
>>>>              */
>>>
>>> It makes the comment ends with a comma, like the end is missing.
>>>
>>>
>>>
>>
>> Yes, better language would be.
>>                /* This should not happen since this function is called
>>                 * from interrupt triggered by GPI ..
> 
> +1
> I've re-worded the last bit.
> 
> 	/* This should not happen since this function is called
> 	 * from interrupt triggered by GPIO (since EPIO can only
> 	 * generate interrupts to MCP).
> 	 * So if this function was called and none of the GPIOs was set,
> 	 * it means something disastrous has already happened.
> 	 */

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Will use above suggested comment while merging.
Ferruh Yigit Oct. 16, 2018, 2:52 p.m. UTC | #5 
On 10/16/2018 3:45 PM, Ferruh Yigit wrote:
> On 9/19/2018 5:40 PM, Mody, Rasesh wrote:
>>> From: Stephen Hemminger <stephen@networkplumber.org>
>>> Sent: Tuesday, September 18, 2018 8:07 AM
>>>
>>> On Tue, 18 Sep 2018 11:40:28 +0200
>>> Thomas Monjalon <thomas@monjalon.net> wrote:
>>>
>>>> 25/07/2018 20:20, Stephen Hemminger:
>>>>> No need for profanity in comments.
>>>>>
>>>>> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
>>>>> ---
>>>>>  drivers/net/bnx2x/elink.c | 4 ++--
>>>>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>>>>
>>>>> diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
>>>>> index 34a29373af3b..08fe817720a1 100644
>>>>> --- a/drivers/net/bnx2x/elink.c
>>>>> +++ b/drivers/net/bnx2x/elink.c
>>>>> @@ -3993,11 +3993,11 @@ static elink_status_t
>>> elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
>>>>>                        PORT_HW_CFG_E3_MOD_ABS_MASK) >>
>>>>>                 PORT_HW_CFG_E3_MOD_ABS_SHIFT;
>>>>>
>>>>> -           /* Should not happen. This function called upon interrupt
>>>>> +           /*
>>>>> +            * Should not happen. This function called upon
>>>>> + interrupt
>>>>>              * triggered by GPIO ( since EPIO can only generate interrupts
>>>>>              * to MCP).
>>>>>              * So if this function was called and none of the GPIOs was set,
>>>>> -            * it means the shit hit the fan.
>>>>>              */
>>>>
>>>> It makes the comment ends with a comma, like the end is missing.
>>>>
>>>>
>>>>
>>>
>>> Yes, better language would be.
>>>                /* This should not happen since this function is called
>>>                 * from interrupt triggered by GPI ..
>>
>> +1
>> I've re-worded the last bit.
>>
>> 	/* This should not happen since this function is called
>> 	 * from interrupt triggered by GPIO (since EPIO can only
>> 	 * generate interrupts to MCP).
>> 	 * So if this function was called and none of the GPIOs was set,
>> 	 * it means something disastrous has already happened.
>> 	 */
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Will use above suggested comment while merging.

Applied to dpdk-next-net/master, thanks.
Burakov, Anatoly Oct. 26, 2018, 2:56 p.m. UTC | #6 
On 25-Jul-18 7:20 PM, Stephen Hemminger wrote:
> No need for profanity in comments.
> 
> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
> ---
>   drivers/net/bnx2x/elink.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
> index 34a29373af3b..08fe817720a1 100644
> --- a/drivers/net/bnx2x/elink.c
> +++ b/drivers/net/bnx2x/elink.c
> @@ -3993,11 +3993,11 @@ static elink_status_t elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
>   			   PORT_HW_CFG_E3_MOD_ABS_MASK) >>
>   		    PORT_HW_CFG_E3_MOD_ABS_SHIFT;
>   
> -		/* Should not happen. This function called upon interrupt
> +		/*
> +		 * Should not happen. This function called upon interrupt
>   		 * triggered by GPIO ( since EPIO can only generate interrupts
>   		 * to MCP).
>   		 * So if this function was called and none of the GPIOs was set,
> -		 * it means the shit hit the fan.

...then what? :)

>   		 */
>   		if ((cfg_pin < PIN_CFG_GPIO0_P0) ||
>   		    (cfg_pin > PIN_CFG_GPIO3_P1)) {
>
diff mbox series

Patch

diff --git a/drivers/net/bnx2x/elink.c b/drivers/net/bnx2x/elink.c
index 34a29373af3b..08fe817720a1 100644
--- a/drivers/net/bnx2x/elink.c
+++ b/drivers/net/bnx2x/elink.c
@@ -3993,11 +3993,11 @@  static elink_status_t elink_get_mod_abs_int_cfg(struct bnx2x_softc *sc,
 			   PORT_HW_CFG_E3_MOD_ABS_MASK) >>
 		    PORT_HW_CFG_E3_MOD_ABS_SHIFT;
 
-		/* Should not happen. This function called upon interrupt
+		/*
+		 * Should not happen. This function called upon interrupt
 		 * triggered by GPIO ( since EPIO can only generate interrupts
 		 * to MCP).
 		 * So if this function was called and none of the GPIOs was set,
-		 * it means the shit hit the fan.
 		 */
 		if ((cfg_pin < PIN_CFG_GPIO0_P0) ||
 		    (cfg_pin > PIN_CFG_GPIO3_P1)) {