[PATCH] mkimage: Improve documentation of algo-name parameter

[PATCH] mkimage: Improve documentation of algo-name parameter

[Jan Kiszka]

From: Jan Kiszka <jan.kiszka@siemens.com>

Addresses the feedback provided on 5902a397d029 which raced with the
merge.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 doc/mkimage.1     | 2 +-
 tools/imagetool.h | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/doc/mkimage.1 b/doc/mkimage.1
index 0734bd36a11..fc84cca066b 100644
--- a/doc/mkimage.1
+++ b/doc/mkimage.1
@@ -158,7 +158,7 @@ CONFIG_OF_CONTROL in U-Boot.
 .TP
 .BI "\-o [" "signing algorithm" "]"
 Specifies the algorithm to be used for signing a FIT image. The default is
-taken from the target signature nodes 'algo' properties.
+taken from the signature node's 'algo' property.
 
 .TP
 .BI "\-p [" "external position" "]"
diff --git a/tools/imagetool.h b/tools/imagetool.h
index a4105515d81..12f911600f9 100644
--- a/tools/imagetool.h
+++ b/tools/imagetool.h
@@ -71,7 +71,8 @@ struct image_tool_params {
 	const char *keydest;	/* Destination .dtb for public key */
 	const char *keyfile;	/* Filename of private or public key */
 	const char *comment;	/* Comment to add to signature node */
-	const char *algo_name;	/* Algorithm name to use hashing/signing */
+	const char *algo_name;	/* Algorithm name to use for hashing/signing or
+				   NULL to use the one specified in the its */
 	int require_keys;	/* 1 to mark signing keys as 'required' */
 	int file_size;		/* Total size of output file */
 	int orig_file_size;	/* Original size for file before padding */
-- 
2.34.1

Re: [PATCH] mkimage: Improve documentation of algo-name parameter

[Simon Glass]

On Thu, 3 Feb 2022 at 13:43, Jan Kiszka <jan.kiszka@siemens.com> wrote:
>
> From: Jan Kiszka <jan.kiszka@siemens.com>
>
> Addresses the feedback provided on 5902a397d029 which raced with the
> merge.
>
> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
> ---
>  doc/mkimage.1     | 2 +-
>  tools/imagetool.h | 3 ++-
>  2 files changed, 3 insertions(+), 2 deletions(-)
>

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

nit below

> diff --git a/doc/mkimage.1 b/doc/mkimage.1
> index 0734bd36a11..fc84cca066b 100644
> --- a/doc/mkimage.1
> +++ b/doc/mkimage.1
> @@ -158,7 +158,7 @@ CONFIG_OF_CONTROL in U-Boot.
>  .TP
>  .BI "\-o [" "signing algorithm" "]"
>  Specifies the algorithm to be used for signing a FIT image. The default is
> -taken from the target signature nodes 'algo' properties.
> +taken from the signature node's 'algo' property.
>
>  .TP
>  .BI "\-p [" "external position" "]"
> diff --git a/tools/imagetool.h b/tools/imagetool.h
> index a4105515d81..12f911600f9 100644
> --- a/tools/imagetool.h
> +++ b/tools/imagetool.h
> @@ -71,7 +71,8 @@ struct image_tool_params {
>         const char *keydest;    /* Destination .dtb for public key */
>         const char *keyfile;    /* Filename of private or public key */
>         const char *comment;    /* Comment to add to signature node */
> -       const char *algo_name;  /* Algorithm name to use hashing/signing */
> +       const char *algo_name;  /* Algorithm name to use for hashing/signing or
> +                                  NULL to use the one specified in the its */

Best to move this to before the code line, since we try to avoid
splitting one-line comments like this.


>         int require_keys;       /* 1 to mark signing keys as 'required' */
>         int file_size;          /* Total size of output file */
>         int orig_file_size;     /* Original size for file before padding */
> --
> 2.34.1