diff mbox series

[v2] blk: fix a couple of trivial documentation typos

Message ID 20221013-blk-doc-typos-v2-0-446172edca28@baylibre.com
State Accepted
Delegated to: Tom Rini
Headers show
Series [v2] blk: fix a couple of trivial documentation typos | expand

Commit Message

Mattijs Korpershoek Oct. 17, 2022, 7:35 a.m. UTC 
In some cases, the param variable is wrong, and in other cases we have
undocumented arguments.

Fix the docs.

Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
---
Changes in v2:

* Don't edit blk_foreach_probe() comment as it's just returing (Simon)
* Link to v1: https://lore.kernel.org/r/20221013-blk-doc-typos-v1-0-8031607c6a4c@baylibre.com
---
 include/blk.h | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)


---
base-commit: 0e49f5c26caf9972137a474065afd4bdfe5ec062
change-id: 20221013-blk-doc-typos-de90e92ccd6b

Best regards,

Comments

Simon Glass Oct. 18, 2022, 4:59 p.m. UTC | #1 
On Mon, 17 Oct 2022 at 01:35, Mattijs Korpershoek
<mkorpershoek@baylibre.com> wrote:
>
> In some cases, the param variable is wrong, and in other cases we have
> undocumented arguments.
>
> Fix the docs.
>
> Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
> ---
> Changes in v2:
>
> * Don't edit blk_foreach_probe() comment as it's just returing (Simon)
> * Link to v1: https://lore.kernel.org/r/20221013-blk-doc-typos-v1-0-8031607c6a4c@baylibre.com
> ---
>  include/blk.h | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
>
Reviewed-by: Simon Glass <sjg@chromium.org>
Tom Rini Oct. 24, 2022, 12:23 p.m. UTC | #2 
On Mon, Oct 17, 2022 at 09:35:04AM +0200, Mattijs Korpershoek wrote:

> In some cases, the param variable is wrong, and in other cases we have
> undocumented arguments.
> 
> Fix the docs.
> 
> Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
> Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/include/blk.h b/include/blk.h
index 8806c382d4e7..d3ab9a10b969 100644
--- a/include/blk.h
+++ b/include/blk.h
@@ -119,7 +119,7 @@  int blkcache_init(void);
  * @param start - starting block number
  * @param blkcnt - number of blocks to read
  * @param blksz - size in bytes of each block
- * @param buf - buffer to contain cached data
+ * @param buffer - buffer to contain cached data
  *
  * Return: - 1 if block returned from cache, 0 otherwise.
  */
@@ -136,7 +136,7 @@  int blkcache_read(int iftype, int dev,
  * @param start - starting block number
  * @param blkcnt - number of blocks available
  * @param blksz - size in bytes of each block
- * @param buf - buffer containing data to cache
+ * @param buffer - buffer containing data to cache
  *
  */
 void blkcache_fill(int iftype, int dev,
@@ -250,7 +250,7 @@  struct blk_ops {
 	 * The MMC standard provides for two boot partitions (numbered 1 and 2),
 	 * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
 	 *
-	 * @desc:	Block device to update
+	 * @dev:	Block device to update
 	 * @hwpart:	Hardware partition number to select. 0 means the raw
 	 *		device, 1 is the first partition, 2 is the second, etc.
 	 * @return 0 if OK, -ve on error
@@ -642,6 +642,7 @@  int blk_print_part_devnum(enum uclass_id uclass_id, int devnum);
  *
  * @uclass_id:	Block device type
  * @devnum:	Device number
+ * @start:	Start block number to read (0=first)
  * @blkcnt:	Number of blocks to read
  * @buffer:	Address to write data to
  * Return: number of blocks read, or -ve error number on error
@@ -654,6 +655,7 @@  ulong blk_read_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
  *
  * @uclass_id:	Block device type
  * @devnum:	Device number
+ * @start:	Start block number to write (0=first)
  * @blkcnt:	Number of blocks to write
  * @buffer:	Address to read data from
  * Return: number of blocks written, or -ve error number on error