[PATCH] sound/soc/codecs: fix spelling typo in comments

[PATCH] sound/soc/codecs: fix spelling typo in comments

[Wang Qing]

Modify the comment typo: "compliment" -> "complement".

Signed-off-by: Wang Qing <wangqing@vivo.com>
---
 sound/soc/codecs/ak4458.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sound/soc/codecs/ak4458.h b/sound/soc/codecs/ak4458.h
index f906215..e43144c
--- a/sound/soc/codecs/ak4458.h
+++ b/sound/soc/codecs/ak4458.h
@@ -49,7 +49,7 @@
 
 /* DIF2	1 0
  *  x	1 0 MSB justified  Figure 3 (default)
- *  x	1 1 I2S Compliment  Figure 4
+ *  x	1 1 I2S Complement  Figure 4
  */
 #define AK4458_DIF_SHIFT	1
 #define AK4458_DIF_MASK		GENMASK(3, 1)
-- 
2.7.4

Re: [PATCH] sound/soc/codecs: fix spelling typo in comments

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 574 bytes --]

On Thu, Sep 24, 2020 at 02:43:59PM +0800, Wang Qing wrote:
> Modify the comment typo: "compliment" -> "complement".

These are both English words, and compliment appears to be the one that
is used in the datasheet for this part... 

Please submit patches using subject lines reflecting the style for the
subsystem, this makes it easier for people to identify relevant patches.
Look at what existing commits in the area you're changing are doing and
make sure your subject lines visually resemble what they're doing.
There's no need to resubmit to fix this alone.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] sound/soc/codecs: fix spelling typo in comments

[Joe Perches]

On Thu, 2020-09-24 at 13:33 +0100, Mark Brown wrote:
> On Thu, Sep 24, 2020 at 02:43:59PM +0800, Wang Qing wrote:
> > Modify the comment typo: "compliment" -> "complement".
> 
> These are both English words,

with rather different meanings.

> and compliment appears to be the one that
> is used in the datasheet for this part... 

It's difficult to fix datasheet typos.

Re: [PATCH] sound/soc/codecs: fix spelling typo in comments

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 434 bytes --]

On Thu, Sep 24, 2020 at 09:01:21AM -0700, Joe Perches wrote:
> On Thu, 2020-09-24 at 13:33 +0100, Mark Brown wrote:

> > and compliment appears to be the one that
> > is used in the datasheet for this part... 

> It's difficult to fix datasheet typos.

Right, and if we search for the thing in the datasheet we should find
the thing in the datasheet so it's best to follow the datsheet even if
we don't think it's correct.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] sound/soc/codecs: fix spelling typo in comments

[Joe Perches]

On Thu, 2020-09-24 at 17:12 +0100, Mark Brown wrote:
> On Thu, Sep 24, 2020 at 09:01:21AM -0700, Joe Perches wrote:
> > On Thu, 2020-09-24 at 13:33 +0100, Mark Brown wrote:
> > > and compliment appears to be the one that
> > > is used in the datasheet for this part... 
> > It's difficult to fix datasheet typos.
> 
> Right, and if we search for the thing in the datasheet we should find
> the thing in the datasheet so it's best to follow the datsheet even if
> we don't think it's correct.

That's one opinion.

Another would be to use the correct word and
if necessary add some comment showing that the
datasheet writer didn't open a dictionary.

	complement (sic: compliment)

I don't believe that's necessary, but opinions
vary.