* [PATCH 1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
@ 2020-04-02 21:40 ` Sergei Shtylyov
2020-04-02 21:42 ` [PATCH 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd Sergei Shtylyov
` (4 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-02 21:40 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When introducing 'struct spi_nor', a number of issues was added in its
kernel-doc comment:
- double article in the heading kernel-doc comment;
- "point" instead of "pointer" for the 'mtd' and 'dev' fields;
- "a" articles instead of "an" for the 'dev' field;
- acronyms in the lower case for the 'dev' field;
- missing "pointer to" for the 'priv' field.
Fix all of those at once...
Fixes: 6e602ef73334 ("mtd: spi-nor: add the basic data structures")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -327,10 +327,10 @@ struct spi_nor_manufacturer;
struct spi_nor_flash_parameter;
/**
- * struct spi_nor - Structure for defining a the SPI NOR layer
- * @mtd: point to a mtd_info structure
+ * struct spi_nor - Structure for defining the SPI NOR layer
+ * @mtd: pointer to an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
- * @dev: point to a spi device, or a spi nor controller device.
+ * @dev: pointer to an SPI device or an SPI NOR controller device
* @spimem: point to the spi mem device
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
@@ -354,7 +354,7 @@ struct spi_nor_flash_parameter;
* settings that can be overwritten by the spi_nor_fixups
* hooks, or dynamically when parsing the SFDP tables.
* @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes.
- * @priv: the private data
+ * @priv: pointer to the private data
*/
struct spi_nor {
struct mtd_info mtd;
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread* [PATCH 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
2020-04-02 21:40 ` [PATCH 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
@ 2020-04-02 21:42 ` Sergei Shtylyov
2020-04-02 21:45 ` [PATCH 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto Sergei Shtylyov
` (3 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-02 21:42 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When embedding 'struct mtd_info' within 'struct spi_nor', the kernel-doc
comment was forgotten. Fix it by dropping the "pointer to" part from the
comment.
Fixes: 1976367173a4 ("mtd: spi-nor: embed struct mtd_info within struct spi_nor")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: renesas-devel/include/linux/mtd/spi-nor.h
===================================================================
--- renesas-devel.orig/include/linux/mtd/spi-nor.h
+++ renesas-devel/include/linux/mtd/spi-nor.h
@@ -554,7 +554,7 @@ struct flash_info;
/**
* struct spi_nor - Structure for defining the SPI NOR layer
- * @mtd: pointer to an mtd_info structure
+ * @mtd: an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
* @dev: pointer to an SPI device or an SPI NOR controller device
* @spimem: point to the spi mem device
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread* [PATCH 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
2020-04-02 21:40 ` [PATCH 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
2020-04-02 21:42 ` [PATCH 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd Sergei Shtylyov
@ 2020-04-02 21:45 ` Sergei Shtylyov
2020-04-02 21:46 ` [PATCH 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
` (2 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-02 21:45 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the '{read|write|reg}_proto' fields to 'struct spi_nor', a
colon was missed in the comment for the spi_nor::reg_proto' -- add it.
Fixes: cfc5604c488c ("mtd: spi-nor: introduce SPI 1-2-2 and SPI 1-4-4 protocols")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: renesas-devel/include/linux/mtd/spi-nor.h
===================================================================
--- renesas-devel.orig/include/linux/mtd/spi-nor.h
+++ renesas-devel/include/linux/mtd/spi-nor.h
@@ -572,7 +572,7 @@ struct flash_info;
* @flags: flag options for the current SPI-NOR (SNOR_F_*)
* @read_proto: the SPI protocol for read operations
* @write_proto: the SPI protocol for write operations
- * @reg_proto the SPI protocol for read_reg/write_reg/erase operations
+ * @reg_proto: the SPI protocol for read_reg/write_reg/erase operations
* @controller_ops: SPI NOR controller driver specific operations.
* @params: [FLASH-SPECIFIC] SPI-NOR flash parameters and settings.
* The structure includes legacy flash parameters and
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread* [PATCH 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (2 preceding siblings ...)
2020-04-02 21:45 ` [PATCH 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto Sergei Shtylyov
@ 2020-04-02 21:46 ` Sergei Shtylyov
2020-04-02 21:48 ` [PATCH 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem Sergei Shtylyov
2020-04-03 19:28 ` [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-02 21:46 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the 'info' field to 'struct spi_nor', some acronyms were in
lower case and some in upper case and the JEDEC acronym mistyped -- fix
these issues.
Fixes: 46dde01f6bab ("mtd: spi-nor: add spi_nor_init() function")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: renesas-devel/include/linux/mtd/spi-nor.h
===================================================================
--- renesas-devel.orig/include/linux/mtd/spi-nor.h
+++ renesas-devel/include/linux/mtd/spi-nor.h
@@ -561,7 +561,7 @@ struct flash_info;
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
* @bouncebuf_size: size of the bounce buffer
- * @info: spi-nor part JDEC MFR id and other info
+ * @info: SPI-NOR part JEDEC MFR ID and other info
* @page_size: the page size of the SPI NOR
* @addr_width: number of address bytes
* @erase_opcode: the opcode for erasing a sector
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread* [PATCH 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (3 preceding siblings ...)
2020-04-02 21:46 ` [PATCH 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
@ 2020-04-02 21:48 ` Sergei Shtylyov
2020-04-03 19:28 ` [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-02 21:48 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the 'spimem' field to 'struct spi_nor', a grammar mistake
("point" instead of "pointer") was made -- fix it and convert the SPI
acronym to uppercase and fully spell out "memory", while at it...
Fixes: b35b9a10362 ("mtd: spi-nor: Move m25p80 code in spi-nor.c")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: renesas-devel/include/linux/mtd/spi-nor.h
===================================================================
--- renesas-devel.orig/include/linux/mtd/spi-nor.h
+++ renesas-devel/include/linux/mtd/spi-nor.h
@@ -557,7 +557,7 @@ struct flash_info;
* @mtd: an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
* @dev: pointer to an SPI device or an SPI NOR controller device
- * @spimem: point to the spi mem device
+ * @spimem: pointer to the SPI memory device
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
* @bouncebuf_size: size of the bounce buffer
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread* Re: [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor'
2020-04-02 21:35 [PATCH 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (4 preceding siblings ...)
2020-04-02 21:48 ` [PATCH 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem Sergei Shtylyov
@ 2020-04-03 19:28 ` Sergei Shtylyov
5 siblings, 0 replies; 7+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 19:28 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
On 04/03/2020 12:35 AM, Sergei Shtylyov wrote:
> Here's a set of 5 patches against the 'spi-nor/next' branch of the MTD 'linux.git'
> repo. I'm fixing a number of the kernel-doc comment to 'struct spi_nor' accumulated
^ issues in
> since its creation. Instead of a single patch, I'm fixing the kernel-doc comment with
> several patches, each fixing its own broken commit -- this simplifies porting to the
> stable kernels (if that ever happens). :-)
>
> [1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
Oops! Only the 1st patch was against a correct repo...
> [2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd
> [3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto
> [4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
> [5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem
The rest was from Geert's renesas-devel.git repo, should still
apply, although with large offsets. I'll repost.
MBR, Sergei
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 7+ messages in thread