Skip to contentSkip to conversation

include/linux/regmap.h: fix a couple of typos

PATCH Superseded Laszlo Papp 3 participants 14 messages Jan 8, 2014 – Jan 9, 2014 Register map abstraction

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 include/linux/regmap.h: fix a couple of typos

These sentences are not proper English due to the typos. I had initially caught one of them while trying to understand the regmap feature, and then I just ran the vim spell checker, and went through all the items that would need to be fixed for this header file.

---
 include/linux/regmap.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
include/linux/regmap.h +5 -5
index e559078..6305657 100644
@@ -122,9 +122,9 @@ typedef void (*regmap_unlock)(void *);
  *		  volatile_table (see below) is not, the check is performed on
  *                such table (a register is volatile if it belongs to one of
  *                the ranges specified by volatile_table).
- * @precious_reg: Optional callback returning true if the rgister
+ * @precious_reg: Optional callback returning true if the register
  *		  should not be read outside of a call from the driver
- *		  (eg, a clear on read interrupt status register). If this
+ *		  (e.g. a clear on read interrupt status register). If this
  *                field is NULL but precious_table (see below) is not, the
  *                check is performed on such table (a register is precious if
  *                it belongs to one of the ranges specified by precious_table).
@@ -136,9 +136,9 @@ typedef void (*regmap_unlock)(void *);
  *		  are not overridden).
  * @reg_read:	  Optional callback that if filled will be used to perform
  *           	  all the reads from the registers. Should only be provided for
- *		  devices whos read operation cannot be represented as a simple read
- *		  operation on a bus such as SPI, I2C, etc. Most of the devices do
- * 		  not need this.
+ *		  devices whose read operation cannot be represented as a simple
+ *		  read operation on a bus such as SPI, I2C, etc. Most of the
+ *		  devices do not need this.
  * @reg_write:	  Same as above for writing.
  * @fast_io:	  Register IO is fast. Use a spinlock instead of a mutex
  *	     	  to perform locking. This field is ignored if custom lock/unlock
Signature · 1 line
1.8.5.1
maintainer
#1 lore raw
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

This is somewhat outdated orthorgraphy...

#2 lore raw
Quoted 6 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

This is somewhat outdated orthorgraphy...

Pardon ?

maintainer
#3 lore raw
Quoted 9 lines · Laszlo Papp
Quoted 6 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

This is somewhat outdated orthorgraphy...

Pardon ?

It's not that common to write it as an abbreviation (even though it is one) and for some random reason you've decided to drop the comma which is standard.

#4 lore raw
Quoted 7 lines · Mark Brown
Quoted 5 lines · Laszlo Papp
Quoted 4 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

This is somewhat outdated orthorgraphy...

Pardon ?

It's not that common to write it as an abbreviation (even though it is one) and for some random reason you've decided to drop the comma which is standard.

Cannot agree. I see this effectively almost anywhere, and I even asked this on IRC from native English speaker in #English @ freenode who were in an agreement with me as far as I can tell.

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

#5 lore raw
Quoted 16 lines · Laszlo Papp
Quoted 7 lines · Mark Brown
Quoted 5 lines · Laszlo Papp
Quoted 4 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

This is somewhat outdated orthorgraphy...

Pardon ?

It's not that common to write it as an abbreviation (even though it is one) and for some random reason you've decided to drop the comma which is standard.

Quoted 6 lines

Cannot agree. I see this effectively almost anywhere, and I even asked this on IRC from native English speaker in #English @ freenode who were in an agreement with me as far as I can tell.

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

Of course, this is just on top of the vim spell checker error as I wrote in the commit message...

Oh yes, and one more factual data in here:

lpapp ~/Projects/linux-staging $ grep -rn "e\.g\." . | wc -l 3447

lpapp ~/Projects/linux-staging $ grep -rn " eg," | wc -l 18

maintainer
#6 lore raw
Quoted 8 lines · Laszlo Papp
Quoted 2 lines · Laszlo Papp

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

Of course, this is just on top of the vim spell checker error as I wrote in the commit message...

Quoted 7 lines

Oh yes, and one more factual data in here:

lpapp ~/Projects/linux-staging $ grep -rn "e\.g\." . | wc -l 3447

lpapp ~/Projects/linux-staging $ grep -rn " eg," | wc -l 18

That's not the issue - it's dropping the comma. It's either "e.g." or "eg", the comma is a separate thing providing a break between clauses. Strictly it should have the periods since it is an abbreviation but their use is more vauge in fixed point text since they look ugly, the thing that made me complain was that you dropped the comma as well as substituting in the expanded version.

#7 lore raw
Quoted 17 lines · Mark Brown
Quoted 8 lines · Laszlo Papp
Quoted 2 lines · Laszlo Papp

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

Of course, this is just on top of the vim spell checker error as I wrote in the commit message...

Quoted 7 lines

Oh yes, and one more factual data in here:

lpapp ~/Projects/linux-staging $ grep -rn "e\.g\." . | wc -l 3447

lpapp ~/Projects/linux-staging $ grep -rn " eg," | wc -l 18

Quoted 6 lines

That's not the issue - it's dropping the comma. It's either "e.g." or "eg", the comma is a separate thing providing a break between clauses. Strictly it should have the periods since it is an abbreviation but their use is more vauge in fixed point text since they look ugly, the thing that made me complain was that you dropped the comma as well as substituting in the expanded version.

I still do not get what point you are trying to make. Could you please provide evidence? Because really, this is the usage I have seen in projects out there all around, including the majority of the linux kernel.

Here is some more data:

grep -rn "e\.g\. " . | wc -l
2553
lpapp ~/Projects/linux-staging $ grep -rn "e\.g\.," . | wc -l 573

#8 lore raw
Quoted 30 lines · Laszlo Papp
Quoted 17 lines · Mark Brown
Quoted 8 lines · Laszlo Papp
Quoted 2 lines · Laszlo Papp

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

Of course, this is just on top of the vim spell checker error as I wrote in the commit message...

Quoted 7 lines

Oh yes, and one more factual data in here:

lpapp ~/Projects/linux-staging $ grep -rn "e\.g\." . | wc -l 3447

lpapp ~/Projects/linux-staging $ grep -rn " eg," | wc -l 18

Quoted 6 lines

That's not the issue - it's dropping the comma. It's either "e.g." or "eg", the comma is a separate thing providing a break between clauses. Strictly it should have the periods since it is an abbreviation but their use is more vauge in fixed point text since they look ugly, the thing that made me complain was that you dropped the comma as well as substituting in the expanded version.

I still do not get what point you are trying to make. Could you please provide evidence? Because really, this is the usage I have seen in projects out there all around, including the majority of the linux kernel.

Quoted 7 lines

Here is some more data:

grep -rn "e\.g\. " . | wc -l
2553
lpapp ~/Projects/linux-staging $ grep -rn "e\.g\.," . | wc -l 573
--

Hi,

I am used to seeing e.g. and i.e. always followed by a comma when they are used to begin a sentence. However, I just checked and some online style guides say to omit the comma and some say to use it, and we (Linux kernel) don't really have a writing style guide to look at. I think that makes it up to the maintainer to decide what is acceptable.

Signature · 1 line
~Randy
#9 lore raw
Quoted 39 lines · Randy Dunlap
Quoted 30 lines · Laszlo Papp
Quoted 17 lines · Mark Brown
Quoted 8 lines · Laszlo Papp
Quoted 2 lines · Laszlo Papp

That being said, I will not have time, nor the motivation to argue over such a nuance, so feel free to reject the change.

Of course, this is just on top of the vim spell checker error as I wrote in the commit message...

Quoted 7 lines

Oh yes, and one more factual data in here:

lpapp ~/Projects/linux-staging $ grep -rn "e\.g\." . | wc -l 3447

lpapp ~/Projects/linux-staging $ grep -rn " eg," | wc -l 18

Quoted 6 lines

That's not the issue - it's dropping the comma. It's either "e.g." or "eg", the comma is a separate thing providing a break between clauses. Strictly it should have the periods since it is an abbreviation but their use is more vauge in fixed point text since they look ugly, the thing that made me complain was that you dropped the comma as well as substituting in the expanded version.

I still do not get what point you are trying to make. Could you please provide evidence? Because really, this is the usage I have seen in projects out there all around, including the majority of the linux kernel.

Quoted 7 lines

Here is some more data:

grep -rn "e\.g\. " . | wc -l
2553
lpapp ~/Projects/linux-staging $ grep -rn "e\.g\.," . | wc -l 573
--

Quoted 7 lines

Hi,

I am used to seeing e.g. and i.e. always followed by a comma when they are used to begin a sentence. However, I just checked and some online style guides say to omit the comma and some say to use it, and we (Linux kernel) don't really have a writing style guide to look at. I think that makes it up to the maintainer to decide what is acceptable.

Who is the maintainer? Is it Mark, or I should wait for someone else?

maintainer
#10 lore raw
Quoted 1 line · Laszlo Papp

Who is the maintainer? Is it Mark, or I should wait for someone else?

Yes, it's me.

maintainer
#11 lore raw
In reply to Randy Dunlap
Quoted 7 lines · Randy Dunlap
Quoted 4 lines · Laszlo Papp

I still do not get what point you are trying to make. Could you please provide evidence? Because really, this is the usage I have seen in projects out there all around, including the majority of the linux kernel.

Quoted 5 lines

I am used to seeing e.g. and i.e. always followed by a comma when they are used to begin a sentence. However, I just checked and some online style guides say to omit the comma and some say to use it, and we (Linux kernel) don't really have a writing style guide to look at. I think that makes it up to the maintainer to decide what is acceptable.

More generally they're just abbreviations for the latin for for example and that is so (to a reasonable approximation) get used in the same way.

#12 lore raw
In reply to Mark Brown
Quoted 7 lines · Mark Brown
Quoted 5 lines · Laszlo Papp
Quoted 4 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

This is somewhat outdated orthorgraphy...

Pardon ?

It's not that common to write it as an abbreviation (even though it is one) and for some random reason you've decided to drop the comma which is standard.

Good catch. I somehow overlooked that change (dropped comma) in the patch.

e.g.,

Signature · 1 line
~Randy
#13 lore raw
In reply to Mark Brown
Quoted 6 lines · Mark Brown
Quoted 2 lines · Laszlo Papp

- * (eg, a clear on read interrupt status register). If this
+ * (e.g. a clear on read interrupt status register). If this

This is somewhat outdated orthorgraphy...

orthography

Anyway, I would merge such a patch if I were a maintainer.

Signature · 1 line
~Randy