diff mbox series

doc: usage: load: document part as hexadecimal

Message ID 20230915221153.2767153-1-yoann.congal@smile.fr
State Accepted, archived
Commit 5bb1d1f9dac08dd84ea1d62eefaf5b7cbba8fe1a
Delegated to: Heinrich Schuchardt
Headers show
Series doc: usage: load: document part as hexadecimal | expand

Commit Message

Yoann Congal Sept. 15, 2023, 10:11 p.m. UTC 
From: Mickaël Tansorier <mickael.tansorier@smile.fr>

`part` option is in hexadecimal, so information is missing in usage
documentation.

Callgraph for `part` parsing is :
do_load -> fs_set_blk_dev -> part_get_info_by_dev_and_name_or_num ->
blk_get_device_part_str -> hextoul (This is why it is hexadecimal)

Signed-off-by: Mickaël Tansorier <mickael.tansorier@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
---
 doc/usage/cmd/load.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Simon Glass Sept. 19, 2023, 1:04 a.m. UTC | #1 
On Fri, 15 Sept 2023 at 21:33, Yoann Congal <yoann.congal@smile.fr> wrote:
>
> From: Mickaël Tansorier <mickael.tansorier@smile.fr>
>
> `part` option is in hexadecimal, so information is missing in usage
> documentation.
>
> Callgraph for `part` parsing is :
> do_load -> fs_set_blk_dev -> part_get_info_by_dev_and_name_or_num ->
> blk_get_device_part_str -> hextoul (This is why it is hexadecimal)
>
> Signed-off-by: Mickaël Tansorier <mickael.tansorier@smile.fr>
> Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
> ---
>  doc/usage/cmd/load.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Simon Glass <sjg@chromium.org>
diff mbox series

Patch

diff --git a/doc/usage/cmd/load.rst b/doc/usage/cmd/load.rst
index 1efee773179..2c892ee1cb7 100644
--- a/doc/usage/cmd/load.rst
+++ b/doc/usage/cmd/load.rst
@@ -40,7 +40,7 @@  bytes
 pos
     number of bytes to skip
 
-addr, bytes, pos are hexadecimal numbers.
+part, addr, bytes, pos are hexadecimal numbers.
 
 Example
 -------