Skip to content

Commit 40a571b

Browse files
Sergei Shtylyovambarus
authored andcommitted
mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
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: 6e602ef ("mtd: spi-nor: add the basic data structures") Signed-off-by: Sergei Shtylyov <[email protected]> Signed-off-by: Tudor Ambarus <[email protected]>
1 parent 150ccc1 commit 40a571b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/linux/mtd/spi-nor.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,10 +327,10 @@ struct spi_nor_manufacturer;
327327
struct spi_nor_flash_parameter;
328328

329329
/**
330-
* struct spi_nor - Structure for defining a the SPI NOR layer
331-
* @mtd: point to a mtd_info structure
330+
* struct spi_nor - Structure for defining the SPI NOR layer
331+
* @mtd: pointer to an mtd_info structure
332332
* @lock: the lock for the read/write/erase/lock/unlock operations
333-
* @dev: point to a spi device, or a spi nor controller device.
333+
* @dev: pointer to an SPI device or an SPI NOR controller device
334334
* @spimem: point to the spi mem device
335335
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
336336
* layer is not DMA-able
@@ -354,7 +354,7 @@ struct spi_nor_flash_parameter;
354354
* settings that can be overwritten by the spi_nor_fixups
355355
* hooks, or dynamically when parsing the SFDP tables.
356356
* @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes.
357-
* @priv: the private data
357+
* @priv: pointer to the private data
358358
*/
359359
struct spi_nor {
360360
struct mtd_info mtd;

0 commit comments

Comments
 (0)