diff mbox series

[1/1] usb: typec: tipd: fix typo in TPS_STATUS_HIGH_VOLAGE_WARNING macro

Message ID 20250521214851.386796-1-jihed.chaibi.dev@gmail.com
State New
Headers show
Series [1/1] usb: typec: tipd: fix typo in TPS_STATUS_HIGH_VOLAGE_WARNING macro | expand

Commit Message

Jihed Chaibi May 21, 2025, 9:48 p.m. UTC
"VOLAGE" should become "VOLTAGE"

Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
 drivers/usb/typec/tipd/tps6598x.h | 2 +-
 drivers/usb/typec/tipd/trace.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Brigham Campbell May 22, 2025, 7:47 a.m. UTC | #1
On Wed May 21, 2025 at 3:48 PM MDT, Jihed Chaibi wrote:
> "VOLAGE" should become "VOLTAGE"
>
> Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>

Nice work! I was able to successfully compile this driver with your
changes and I don't see any further references to the misspelled macro.

Patches which fix issues which were introduced in some previous commit
typically indicate the offending commit via the "Fixes" tag. Admittedly,
I don't know if the tag is reserved for technical bugs rather than typos
such as the one you addressed, but such a tag would look like the
following for this patch:

Fixes: e011178579b57c03 ("usb: typec: tipd: fix typo in TPS_STATUS_HIGH_VOLAGE_WARNING macro")

> ---
>  drivers/usb/typec/tipd/tps6598x.h | 2 +-
>  drivers/usb/typec/tipd/trace.h    | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/usb/typec/tipd/tps6598x.h b/drivers/usb/typec/tipd/tps6598x.h
> index 9b23e9017..cecb8d11d 100644
> --- a/drivers/usb/typec/tipd/tps6598x.h
> +++ b/drivers/usb/typec/tipd/tps6598x.h
> @@ -27,7 +27,7 @@
>  #define TPS_STATUS_OVERCURRENT		BIT(16)
>  #define TPS_STATUS_GOTO_MIN_ACTIVE	BIT(26)
>  #define TPS_STATUS_BIST			BIT(27)
> -#define TPS_STATUS_HIGH_VOLAGE_WARNING	BIT(28)
> +#define TPS_STATUS_HIGH_VOLTAGE_WARNING	BIT(28)
>  #define TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING BIT(29)
>  
>  #define TPS_STATUS_CONN_STATE_MASK		GENMASK(3, 1)
> diff --git a/drivers/usb/typec/tipd/trace.h b/drivers/usb/typec/tipd/trace.h
> index 0669cca12..bea383f2d 100644
> --- a/drivers/usb/typec/tipd/trace.h
> +++ b/drivers/usb/typec/tipd/trace.h
> @@ -153,7 +153,7 @@
>  		      { TPS_STATUS_OVERCURRENT,		"OVERCURRENT" }, \
>  		      { TPS_STATUS_GOTO_MIN_ACTIVE,	"GOTO_MIN_ACTIVE" }, \
>  		      { TPS_STATUS_BIST,		"BIST" }, \
> -		      { TPS_STATUS_HIGH_VOLAGE_WARNING,	"HIGH_VOLAGE_WARNING" }, \
> +		      { TPS_STATUS_HIGH_VOLTAGE_WARNING,	"HIGH_VOLTAGE_WARNING" }, \
>  		      { TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING, "HIGH_LOW_VOLTAGE_WARNING" })

Consider making "HIGH_LOW_VOLTAGE_WARNING" inline with
"HIGH_VOLTAGE_WARNING", or vice versa.

>  
>  #define show_tps25750_status_flags(flags) \

Reviewed-by: Brigham Campbell <me@brighamcampbell.com>
Greg Kroah-Hartman May 22, 2025, 8:30 a.m. UTC | #2
On Thu, May 22, 2025 at 01:47:54AM -0600, Brigham Campbell wrote:
> On Wed May 21, 2025 at 3:48 PM MDT, Jihed Chaibi wrote:
> > "VOLAGE" should become "VOLTAGE"
> >
> > Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
> 
> Nice work! I was able to successfully compile this driver with your
> changes and I don't see any further references to the misspelled macro.
> 
> Patches which fix issues which were introduced in some previous commit
> typically indicate the offending commit via the "Fixes" tag. Admittedly,
> I don't know if the tag is reserved for technical bugs rather than typos
> such as the one you addressed, but such a tag would look like the
> following for this patch:
> 
> Fixes: e011178579b57c03 ("usb: typec: tipd: fix typo in TPS_STATUS_HIGH_VOLAGE_WARNING macro")

Too many characters for that sha1 value :)

thanks,

greg k-hj
Jihed Chaibi May 22, 2025, 11:10 a.m. UTC | #3
On Thu, May 22, 2025 at 10:30 AM Greg KH <gregkh@linuxfoundation.org> wrote:
>
> On Thu, May 22, 2025 at 01:47:54AM -0600, Brigham Campbell wrote:
> > On Wed May 21, 2025 at 3:48 PM MDT, Jihed Chaibi wrote:
> > > "VOLAGE" should become "VOLTAGE"
> > >
> > > Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
> >
> > Nice work! I was able to successfully compile this driver with your
> > changes and I don't see any further references to the misspelled macro.
> >
> > Patches which fix issues which were introduced in some previous commit
> > typically indicate the offending commit via the "Fixes" tag. Admittedly,
> > I don't know if the tag is reserved for technical bugs rather than typos
> > such as the one you addressed, but such a tag would look like the
> > following for this patch:
> >
> > Fixes: e011178579b57c03 ("usb: typec: tipd: fix typo in TPS_STATUS_HIGH_VOLAGE_WARNING macro")
>
> Too many characters for that sha1 value :)
>
> thanks,
>
> greg k-hj

Thanks for the feedback!
I assumed this tiny typo fix might not need a "Fixes:" tag since it
doesn’t really "fix" any functional issue—just let me know if you
disagree. I’m just beginning my kernel contribution journey, so I
appreciate any guidance.
Cheers,
Brigham Campbell May 22, 2025, 4:21 p.m. UTC | #4
On Thu May 22, 2025 at 2:30 AM MDT, Greg KH wrote:
>
> Too many characters for that sha1 value :)

I heard recently about concerns regarding the collision of 12-character
sha1 abbreviations [1] and had assumed that using 16 characters is
acceptable. Regrettably, I neglected to read Linus's response to the
email which rose those concerns. After reading his response, I'm
satisfied knowing that there is still very little risk of a collision
between the abbreviations of commit objects specifically.

I'll modify my git config to use 12 character abbrevs.

Thanks,
Brigham

[1]: https://lore.kernel.org/lkml/cover.1733421037.git.geert+renesas@glider.be/
Greg Kroah-Hartman May 22, 2025, 4:36 p.m. UTC | #5
On Thu, May 22, 2025 at 10:21:10AM -0600, Brigham Campbell wrote:
> On Thu May 22, 2025 at 2:30 AM MDT, Greg KH wrote:
> >
> > Too many characters for that sha1 value :)
> 
> I heard recently about concerns regarding the collision of 12-character
> sha1 abbreviations [1] and had assumed that using 16 characters is
> acceptable. Regrettably, I neglected to read Linus's response to the
> email which rose those concerns. After reading his response, I'm
> satisfied knowing that there is still very little risk of a collision
> between the abbreviations of commit objects specifically.
> 
> I'll modify my git config to use 12 character abbrevs.

The documentation should have the git config settings that are needed:
	[core]
	        abbrev = 12
diff mbox series

Patch

diff --git a/drivers/usb/typec/tipd/tps6598x.h b/drivers/usb/typec/tipd/tps6598x.h
index 9b23e9017..cecb8d11d 100644
--- a/drivers/usb/typec/tipd/tps6598x.h
+++ b/drivers/usb/typec/tipd/tps6598x.h
@@ -27,7 +27,7 @@ 
 #define TPS_STATUS_OVERCURRENT		BIT(16)
 #define TPS_STATUS_GOTO_MIN_ACTIVE	BIT(26)
 #define TPS_STATUS_BIST			BIT(27)
-#define TPS_STATUS_HIGH_VOLAGE_WARNING	BIT(28)
+#define TPS_STATUS_HIGH_VOLTAGE_WARNING	BIT(28)
 #define TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING BIT(29)
 
 #define TPS_STATUS_CONN_STATE_MASK		GENMASK(3, 1)
diff --git a/drivers/usb/typec/tipd/trace.h b/drivers/usb/typec/tipd/trace.h
index 0669cca12..bea383f2d 100644
--- a/drivers/usb/typec/tipd/trace.h
+++ b/drivers/usb/typec/tipd/trace.h
@@ -153,7 +153,7 @@ 
 		      { TPS_STATUS_OVERCURRENT,		"OVERCURRENT" }, \
 		      { TPS_STATUS_GOTO_MIN_ACTIVE,	"GOTO_MIN_ACTIVE" }, \
 		      { TPS_STATUS_BIST,		"BIST" }, \
-		      { TPS_STATUS_HIGH_VOLAGE_WARNING,	"HIGH_VOLAGE_WARNING" }, \
+		      { TPS_STATUS_HIGH_VOLTAGE_WARNING,	"HIGH_VOLTAGE_WARNING" }, \
 		      { TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING, "HIGH_LOW_VOLTAGE_WARNING" })
 
 #define show_tps25750_status_flags(flags) \