[PATCH] mtd: s/a SPI/an SPI

[PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

The deciding factor for when a/an should be used is the sound
that begins the word which follows these indefinite articles,
rather than the letter which does. Use "an SPI". (SPI begins
with the consonant letter S, but the S is pronounced with its
letter name, "es.")

Used sed to do the replacement:
find include/linux/mtd/ -type f -exec sed -i "s/ a SPI/ an SPI/g" {} \;
find drivers/mtd/ -type f -exec sed -i "s/ a SPI/ an SPI/g" {} \;

Signed-off-by: Tudor Ambarus <tudor.ambarus@linaro.org>
---
 drivers/mtd/spi-nor/controllers/Kconfig |  2 +-
 drivers/mtd/spi-nor/core.c              | 14 +++++++-------
 drivers/mtd/spi-nor/core.h              |  4 ++--
 drivers/mtd/spi-nor/sfdp.c              |  6 +++---
 include/linux/mtd/spinand.h             | 14 +++++++-------
 5 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/drivers/mtd/spi-nor/controllers/Kconfig b/drivers/mtd/spi-nor/controllers/Kconfig
index ca45dcd3ffe8..250295c8d85c 100644
--- a/drivers/mtd/spi-nor/controllers/Kconfig
+++ b/drivers/mtd/spi-nor/controllers/Kconfig
@@ -14,5 +14,5 @@ config SPI_NXP_SPIFI
 	  Enable support for the NXP LPC SPI Flash Interface controller.
 
 	  SPIFI is a specialized controller for connecting serial SPI
-	  Flash. Enable this option if you have a device with a SPIFI
+	  Flash. Enable this option if you have a device with an SPIFI
 	  controller and want to access the Flash as a mtd device.
diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
index 22cb18b6c941..875fe7a8b1cb 100644
--- a/drivers/mtd/spi-nor/core.c
+++ b/drivers/mtd/spi-nor/core.c
@@ -1137,7 +1137,7 @@ int spi_nor_erase_sector(struct spi_nor *nor, u32 addr)
 
 /**
  * spi_nor_div_by_erase_size() - calculate remainder and update new dividend
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @dividend:	dividend value
  * @remainder:	pointer to u32 remainder (will be updated)
  *
@@ -1158,7 +1158,7 @@ static u64 spi_nor_div_by_erase_size(const struct spi_nor_erase_type *erase,
  *				    which the address fits is expected to be
  *				    provided.
  * @map:	the erase map of the SPI NOR
- * @region:	pointer to a structure that describes a SPI NOR erase region
+ * @region:	pointer to a structure that describes an SPI NOR erase region
  * @addr:	offset in the serial flash memory
  * @len:	number of bytes to erase
  *
@@ -1216,7 +1216,7 @@ static u64 spi_nor_region_end(const struct spi_nor_erase_region *region)
 
 /**
  * spi_nor_region_next() - get the next spi nor region
- * @region:	pointer to a structure that describes a SPI NOR erase region
+ * @region:	pointer to a structure that describes an SPI NOR erase region
  *
  * Return: the next spi nor region or NULL if last region.
  */
@@ -1259,8 +1259,8 @@ spi_nor_find_erase_region(const struct spi_nor_erase_map *map, u64 addr)
 
 /**
  * spi_nor_init_erase_cmd() - initialize an erase command
- * @region:	pointer to a structure that describes a SPI NOR erase region
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @region:	pointer to a structure that describes an SPI NOR erase region
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  *
  * Return: the pointer to the allocated erase command, ERR_PTR(-errno)
  *	   otherwise.
@@ -2010,8 +2010,8 @@ spi_nor_spimem_adjust_hwcaps(struct spi_nor *nor, u32 *hwcaps)
 }
 
 /**
- * spi_nor_set_erase_type() - set a SPI NOR erase type
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * spi_nor_set_erase_type() - set an SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @size:	the size of the sector/block erased by the erase type
  * @opcode:	the SPI command op code to erase the sector/block
  */
diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
index 25423225c29d..39dde1cc1092 100644
--- a/drivers/mtd/spi-nor/core.h
+++ b/drivers/mtd/spi-nor/core.h
@@ -189,7 +189,7 @@ enum spi_nor_pp_command_index {
 };
 
 /**
- * struct spi_nor_erase_type - Structure to describe a SPI NOR erase type
+ * struct spi_nor_erase_type - Structure to describe an SPI NOR erase type
  * @size:		the size of the sector/block erased by the erase type.
  *			JEDEC JESD216B imposes erase sizes to be a power of 2.
  * @size_shift:		@size is a power of 2, the shift is stored in
@@ -228,7 +228,7 @@ struct spi_nor_erase_command {
 };
 
 /**
- * struct spi_nor_erase_region - Structure to describe a SPI NOR erase region
+ * struct spi_nor_erase_region - Structure to describe an SPI NOR erase region
  * @offset:		the offset in the data array of erase region start.
  *			LSB bits are used as a bitmask encoding flags to
  *			determine if this region is overlaid, if this region is
diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
index 298ab5e53a8c..39fd535416f0 100644
--- a/drivers/mtd/spi-nor/sfdp.c
+++ b/drivers/mtd/spi-nor/sfdp.c
@@ -304,7 +304,7 @@ static const struct sfdp_bfpt_erase sfdp_bfpt_erases[] = {
 
 /**
  * spi_nor_set_erase_settings_from_bfpt() - set erase type settings from BFPT
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @size:	the size of the sector/block erased by the erase type
  * @opcode:	the SPI command op code to erase the sector/block
  * @i:		erase type index as sorted in the Basic Flash Parameter Table
@@ -775,8 +775,8 @@ static void spi_nor_region_mark_overlay(struct spi_nor_erase_region *region)
 
 /**
  * spi_nor_region_check_overlay() - set overlay bit when the region is overlaid
- * @region:	pointer to a structure that describes a SPI NOR erase region
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @region:	pointer to a structure that describes an SPI NOR erase region
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @erase_type:	erase type bitmask
  */
 static void
diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
index 6d3392a7edc6..2564de8b6ed3 100644
--- a/include/linux/mtd/spinand.h
+++ b/include/linux/mtd/spinand.h
@@ -231,8 +231,8 @@ struct spinand_devid {
 
 /**
  * struct manufacurer_ops - SPI NAND manufacturer specific operations
- * @init: initialize a SPI NAND device
- * @cleanup: cleanup a SPI NAND device
+ * @init: initialize an SPI NAND device
+ * @cleanup: cleanup an SPI NAND device
  *
  * Each SPI NAND manufacturer driver should implement this interface so that
  * NAND chips coming from this vendor can be initialized properly.
@@ -293,7 +293,7 @@ struct spinand_op_variants {
 	}
 
 /**
- * spinand_ecc_info - description of the on-die ECC implemented by a SPI NAND
+ * spinand_ecc_info - description of the on-die ECC implemented by an SPI NAND
  *		      chip
  * @get_status: get the ECC status. Should return a positive number encoding
  *		the number of corrected bitflips if correction was possible or
@@ -462,7 +462,7 @@ static inline struct spinand_device *mtd_to_spinand(struct mtd_info *mtd)
 }
 
 /**
- * spinand_to_mtd() - Get the MTD device embedded in a SPI NAND device
+ * spinand_to_mtd() - Get the MTD device embedded in an SPI NAND device
  * @spinand: SPI NAND device
  *
  * Return: the MTD device embedded in @spinand.
@@ -484,7 +484,7 @@ static inline struct spinand_device *nand_to_spinand(struct nand_device *nand)
 }
 
 /**
- * spinand_to_nand() - Get the NAND device embedded in a SPI NAND object
+ * spinand_to_nand() - Get the NAND device embedded in an SPI NAND object
  * @spinand: SPI NAND device
  *
  * Return: the NAND device embedded in @spinand.
@@ -496,11 +496,11 @@ spinand_to_nand(struct spinand_device *spinand)
 }
 
 /**
- * spinand_set_of_node - Attach a DT node to a SPI NAND device
+ * spinand_set_of_node - Attach a DT node to an SPI NAND device
  * @spinand: SPI NAND device
  * @np: DT node
  *
- * Attach a DT node to a SPI NAND device.
+ * Attach a DT node to an SPI NAND device.
  */
 static inline void spinand_set_of_node(struct spinand_device *spinand,
 				       struct device_node *np)
-- 
2.34.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

[PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

The deciding factor for when a/an should be used is the sound
that begins the word which follows these indefinite articles,
rather than the letter which does. Use "an SPI". (SPI begins
with the consonant letter S, but the S is pronounced with its
letter name, "es.")

Used sed to do the replacement:
find include/linux/mtd/ -type f -exec sed -i "s/ a SPI/ an SPI/g" {} \;
find drivers/mtd/ -type f -exec sed -i "s/ a SPI/ an SPI/g" {} \;

Signed-off-by: Tudor Ambarus <tudor.ambarus@linaro.org>
---
 drivers/mtd/spi-nor/controllers/Kconfig |  2 +-
 drivers/mtd/spi-nor/core.c              | 14 +++++++-------
 drivers/mtd/spi-nor/core.h              |  4 ++--
 drivers/mtd/spi-nor/sfdp.c              |  6 +++---
 include/linux/mtd/spinand.h             | 14 +++++++-------
 5 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/drivers/mtd/spi-nor/controllers/Kconfig b/drivers/mtd/spi-nor/controllers/Kconfig
index ca45dcd3ffe8..250295c8d85c 100644
--- a/drivers/mtd/spi-nor/controllers/Kconfig
+++ b/drivers/mtd/spi-nor/controllers/Kconfig
@@ -14,5 +14,5 @@ config SPI_NXP_SPIFI
 	  Enable support for the NXP LPC SPI Flash Interface controller.
 
 	  SPIFI is a specialized controller for connecting serial SPI
-	  Flash. Enable this option if you have a device with a SPIFI
+	  Flash. Enable this option if you have a device with an SPIFI
 	  controller and want to access the Flash as a mtd device.
diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
index 22cb18b6c941..875fe7a8b1cb 100644
--- a/drivers/mtd/spi-nor/core.c
+++ b/drivers/mtd/spi-nor/core.c
@@ -1137,7 +1137,7 @@ int spi_nor_erase_sector(struct spi_nor *nor, u32 addr)
 
 /**
  * spi_nor_div_by_erase_size() - calculate remainder and update new dividend
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @dividend:	dividend value
  * @remainder:	pointer to u32 remainder (will be updated)
  *
@@ -1158,7 +1158,7 @@ static u64 spi_nor_div_by_erase_size(const struct spi_nor_erase_type *erase,
  *				    which the address fits is expected to be
  *				    provided.
  * @map:	the erase map of the SPI NOR
- * @region:	pointer to a structure that describes a SPI NOR erase region
+ * @region:	pointer to a structure that describes an SPI NOR erase region
  * @addr:	offset in the serial flash memory
  * @len:	number of bytes to erase
  *
@@ -1216,7 +1216,7 @@ static u64 spi_nor_region_end(const struct spi_nor_erase_region *region)
 
 /**
  * spi_nor_region_next() - get the next spi nor region
- * @region:	pointer to a structure that describes a SPI NOR erase region
+ * @region:	pointer to a structure that describes an SPI NOR erase region
  *
  * Return: the next spi nor region or NULL if last region.
  */
@@ -1259,8 +1259,8 @@ spi_nor_find_erase_region(const struct spi_nor_erase_map *map, u64 addr)
 
 /**
  * spi_nor_init_erase_cmd() - initialize an erase command
- * @region:	pointer to a structure that describes a SPI NOR erase region
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @region:	pointer to a structure that describes an SPI NOR erase region
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  *
  * Return: the pointer to the allocated erase command, ERR_PTR(-errno)
  *	   otherwise.
@@ -2010,8 +2010,8 @@ spi_nor_spimem_adjust_hwcaps(struct spi_nor *nor, u32 *hwcaps)
 }
 
 /**
- * spi_nor_set_erase_type() - set a SPI NOR erase type
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * spi_nor_set_erase_type() - set an SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @size:	the size of the sector/block erased by the erase type
  * @opcode:	the SPI command op code to erase the sector/block
  */
diff --git a/drivers/mtd/spi-nor/core.h b/drivers/mtd/spi-nor/core.h
index 25423225c29d..39dde1cc1092 100644
--- a/drivers/mtd/spi-nor/core.h
+++ b/drivers/mtd/spi-nor/core.h
@@ -189,7 +189,7 @@ enum spi_nor_pp_command_index {
 };
 
 /**
- * struct spi_nor_erase_type - Structure to describe a SPI NOR erase type
+ * struct spi_nor_erase_type - Structure to describe an SPI NOR erase type
  * @size:		the size of the sector/block erased by the erase type.
  *			JEDEC JESD216B imposes erase sizes to be a power of 2.
  * @size_shift:		@size is a power of 2, the shift is stored in
@@ -228,7 +228,7 @@ struct spi_nor_erase_command {
 };
 
 /**
- * struct spi_nor_erase_region - Structure to describe a SPI NOR erase region
+ * struct spi_nor_erase_region - Structure to describe an SPI NOR erase region
  * @offset:		the offset in the data array of erase region start.
  *			LSB bits are used as a bitmask encoding flags to
  *			determine if this region is overlaid, if this region is
diff --git a/drivers/mtd/spi-nor/sfdp.c b/drivers/mtd/spi-nor/sfdp.c
index 298ab5e53a8c..39fd535416f0 100644
--- a/drivers/mtd/spi-nor/sfdp.c
+++ b/drivers/mtd/spi-nor/sfdp.c
@@ -304,7 +304,7 @@ static const struct sfdp_bfpt_erase sfdp_bfpt_erases[] = {
 
 /**
  * spi_nor_set_erase_settings_from_bfpt() - set erase type settings from BFPT
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @size:	the size of the sector/block erased by the erase type
  * @opcode:	the SPI command op code to erase the sector/block
  * @i:		erase type index as sorted in the Basic Flash Parameter Table
@@ -775,8 +775,8 @@ static void spi_nor_region_mark_overlay(struct spi_nor_erase_region *region)
 
 /**
  * spi_nor_region_check_overlay() - set overlay bit when the region is overlaid
- * @region:	pointer to a structure that describes a SPI NOR erase region
- * @erase:	pointer to a structure that describes a SPI NOR erase type
+ * @region:	pointer to a structure that describes an SPI NOR erase region
+ * @erase:	pointer to a structure that describes an SPI NOR erase type
  * @erase_type:	erase type bitmask
  */
 static void
diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
index 6d3392a7edc6..2564de8b6ed3 100644
--- a/include/linux/mtd/spinand.h
+++ b/include/linux/mtd/spinand.h
@@ -231,8 +231,8 @@ struct spinand_devid {
 
 /**
  * struct manufacurer_ops - SPI NAND manufacturer specific operations
- * @init: initialize a SPI NAND device
- * @cleanup: cleanup a SPI NAND device
+ * @init: initialize an SPI NAND device
+ * @cleanup: cleanup an SPI NAND device
  *
  * Each SPI NAND manufacturer driver should implement this interface so that
  * NAND chips coming from this vendor can be initialized properly.
@@ -293,7 +293,7 @@ struct spinand_op_variants {
 	}
 
 /**
- * spinand_ecc_info - description of the on-die ECC implemented by a SPI NAND
+ * spinand_ecc_info - description of the on-die ECC implemented by an SPI NAND
  *		      chip
  * @get_status: get the ECC status. Should return a positive number encoding
  *		the number of corrected bitflips if correction was possible or
@@ -462,7 +462,7 @@ static inline struct spinand_device *mtd_to_spinand(struct mtd_info *mtd)
 }
 
 /**
- * spinand_to_mtd() - Get the MTD device embedded in a SPI NAND device
+ * spinand_to_mtd() - Get the MTD device embedded in an SPI NAND device
  * @spinand: SPI NAND device
  *
  * Return: the MTD device embedded in @spinand.
@@ -484,7 +484,7 @@ static inline struct spinand_device *nand_to_spinand(struct nand_device *nand)
 }
 
 /**
- * spinand_to_nand() - Get the NAND device embedded in a SPI NAND object
+ * spinand_to_nand() - Get the NAND device embedded in an SPI NAND object
  * @spinand: SPI NAND device
  *
  * Return: the NAND device embedded in @spinand.
@@ -496,11 +496,11 @@ spinand_to_nand(struct spinand_device *spinand)
 }
 
 /**
- * spinand_set_of_node - Attach a DT node to a SPI NAND device
+ * spinand_set_of_node - Attach a DT node to an SPI NAND device
  * @spinand: SPI NAND device
  * @np: DT node
  *
- * Attach a DT node to a SPI NAND device.
+ * Attach a DT node to an SPI NAND device.
  */
 static inline void spinand_set_of_node(struct spinand_device *spinand,
 				       struct device_node *np)
-- 
2.34.1

Re: [PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

Sent a tree wide patch instead, feel free to comment at:
https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u

Re: [PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

Sent a tree wide patch instead, feel free to comment at:
https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Re: [PATCH] mtd: s/a SPI/an SPI

[Miquel Raynal]

Hi Tudor,

tudor.ambarus@linaro.org wrote on Fri, 3 Feb 2023 12:18:25 +0200:

> Sent a tree wide patch instead, feel free to comment at:
> https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u

I'm wondering how relevant this change is, because I ear a lot of
people (including me) saying both:
- "an ess P. I. controller"
and
- "a [spi] controller"

Anyway, I won't oppose either.

Thanks,
Miquèl

Re: [PATCH] mtd: s/a SPI/an SPI

[Miquel Raynal]

Hi Tudor,

tudor.ambarus@linaro.org wrote on Fri, 3 Feb 2023 12:18:25 +0200:

> Sent a tree wide patch instead, feel free to comment at:
> https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u

I'm wondering how relevant this change is, because I ear a lot of
people (including me) saying both:
- "an ess P. I. controller"
and
- "a [spi] controller"

Anyway, I won't oppose either.

Thanks,
Miquèl

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Re: [PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

On 2/3/23 14:22, Miquel Raynal wrote:
> Hi Tudor,

hey,

> 
> tudor.ambarus@linaro.org wrote on Fri, 3 Feb 2023 12:18:25 +0200:
> 
>> Sent a tree wide patch instead, feel free to comment at:
>> https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u
> 
> I'm wondering how relevant this change is, because I ear a lot of
> people (including me) saying both:
> - "an ess P. I. controller"
> and
> - "a [spi] controller"
> 

Right, I already agreed to drop the tree wide patch. We can choose the
article that suits our own pronunciation. I find the following useful:
https://www.merriam-webster.com/words-at-play/is-it-a-or-an

Re: [PATCH] mtd: s/a SPI/an SPI

[Tudor Ambarus]

On 2/3/23 14:22, Miquel Raynal wrote:
> Hi Tudor,

hey,

> 
> tudor.ambarus@linaro.org wrote on Fri, 3 Feb 2023 12:18:25 +0200:
> 
>> Sent a tree wide patch instead, feel free to comment at:
>> https://lore.kernel.org/all/20230203101624.474611-1-tudor.ambarus@linaro.org/T/#u
> 
> I'm wondering how relevant this change is, because I ear a lot of
> people (including me) saying both:
> - "an ess P. I. controller"
> and
> - "a [spi] controller"
> 

Right, I already agreed to drop the tree wide patch. We can choose the
article that suits our own pronunciation. I find the following useful:
https://www.merriam-webster.com/words-at-play/is-it-a-or-an


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/