[PATCH 1/1] doc: rework doc/mkeficapsule.1

[PATCH 1/1] doc: rework doc/mkeficapsule.1

[Heinrich Schuchardt]

* Indicate the location of the directory for EFI capsules.
* Improve the readability.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 doc/mkeficapsule.1 | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
index 6fb2dd0810..1ca245a10f 100644
--- a/doc/mkeficapsule.1
+++ b/doc/mkeficapsule.1
@@ -11,22 +11,23 @@ mkeficapsule \- Generate EFI capsule file for U-Boot
 .RI [ options ] " " [ image-blob ] " " capsule-file
 
 .SH "DESCRIPTION"
+The
 .B mkeficapsule
-command is used to create an EFI capsule file for use with the U-Boot
-EFI capsule update.
-A capsule file may contain various type of firmware blobs which
-are to be applied to the system and must be placed in the specific
-directory on the UEFI system partition.
-An update will be automatically executed at next reboot.
+command is used to create an EFI capsule file to be used by U-Boot for firmware
+updates.
+A capsule file may contain various types of firmware blobs which are to be
+applied to the system.
+If a capsule file is placed in the /EFI/CapusuleUpdate directory of the EFI
+system partition, U-Boot will try to execute the update at the next reboot.
 
 Optionally, a capsule file can be signed with a given private key.
 In this case, the update will be authenticated by verifying the signature
 before applying.
 
-Additionally, an empty capsule file can be generated for acceptance or
-rejection of firmware images by a governing component like an Operating
-System. The empty capsules do not require an image-blob input file.
-
+Additionally, an empty capsule file can be generated to indicate the acceptance
+or rejection of firmware images by a governing component like an operating
+system.
+Empty capsules do not require an image-blob input file.
 
 .B mkeficapsule
 takes any type of image files when generating non empty capsules, including:
-- 
2.38.1

Re: [PATCH 1/1] doc: rework doc/mkeficapsule.1

[Simon Glass]

Hi Heinrich,

On Mon, 23 Jan 2023 at 04:24, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> * Indicate the location of the directory for EFI capsules.
> * Improve the readability.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  doc/mkeficapsule.1 | 21 +++++++++++----------
>  1 file changed, 11 insertions(+), 10 deletions(-)
>
> diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
> index 6fb2dd0810..1ca245a10f 100644
> --- a/doc/mkeficapsule.1
> +++ b/doc/mkeficapsule.1
> @@ -11,22 +11,23 @@ mkeficapsule \- Generate EFI capsule file for U-Boot
>  .RI [ options ] " " [ image-blob ] " " capsule-file
>
>  .SH "DESCRIPTION"
> +The
>  .B mkeficapsule
> -command is used to create an EFI capsule file for use with the U-Boot
> -EFI capsule update.
> -A capsule file may contain various type of firmware blobs which
> -are to be applied to the system and must be placed in the specific
> -directory on the UEFI system partition.
> -An update will be automatically executed at next reboot.
> +command is used to create an EFI capsule file to be used by U-Boot for firmware
> +updates.
> +A capsule file may contain various types of firmware blobs which are to be
> +applied to the system.
> +If a capsule file is placed in the /EFI/CapusuleUpdate directory of the EFI
> +system partition, U-Boot will try to execute the update at the next reboot.
>
>  Optionally, a capsule file can be signed with a given private key.
>  In this case, the update will be authenticated by verifying the signature
>  before applying.
>
> -Additionally, an empty capsule file can be generated for acceptance or
> -rejection of firmware images by a governing component like an Operating
> -System. The empty capsules do not require an image-blob input file.
> -
> +Additionally, an empty capsule file can be generated to indicate the acceptance
> +or rejection of firmware images by a governing component like an operating
> +system.
> +Empty capsules do not require an image-blob input file.
>
>  .B mkeficapsule
>  takes any type of image files when generating non empty capsules, including:
> --
> 2.38.1
>

BTW as someone else mentioned, this functionality should be in binman too.

Regards,
Simon

Re: [PATCH 1/1] doc: rework doc/mkeficapsule.1

[Heinrich Schuchardt]

On 1/23/23 19:42, Simon Glass wrote:
> Hi Heinrich,
> 
> On Mon, 23 Jan 2023 at 04:24, Heinrich Schuchardt
> <heinrich.schuchardt@canonical.com> wrote:
>>
>> * Indicate the location of the directory for EFI capsules.
>> * Improve the readability.
>>
>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
>> ---
>>   doc/mkeficapsule.1 | 21 +++++++++++----------
>>   1 file changed, 11 insertions(+), 10 deletions(-)
>>
>> diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
>> index 6fb2dd0810..1ca245a10f 100644
>> --- a/doc/mkeficapsule.1
>> +++ b/doc/mkeficapsule.1
>> @@ -11,22 +11,23 @@ mkeficapsule \- Generate EFI capsule file for U-Boot
>>   .RI [ options ] " " [ image-blob ] " " capsule-file
>>
>>   .SH "DESCRIPTION"
>> +The
>>   .B mkeficapsule
>> -command is used to create an EFI capsule file for use with the U-Boot
>> -EFI capsule update.
>> -A capsule file may contain various type of firmware blobs which
>> -are to be applied to the system and must be placed in the specific
>> -directory on the UEFI system partition.
>> -An update will be automatically executed at next reboot.
>> +command is used to create an EFI capsule file to be used by U-Boot for firmware
>> +updates.
>> +A capsule file may contain various types of firmware blobs which are to be
>> +applied to the system.
>> +If a capsule file is placed in the /EFI/CapusuleUpdate directory of the EFI
>> +system partition, U-Boot will try to execute the update at the next reboot.
>>
>>   Optionally, a capsule file can be signed with a given private key.
>>   In this case, the update will be authenticated by verifying the signature
>>   before applying.
>>
>> -Additionally, an empty capsule file can be generated for acceptance or
>> -rejection of firmware images by a governing component like an Operating
>> -System. The empty capsules do not require an image-blob input file.
>> -
>> +Additionally, an empty capsule file can be generated to indicate the acceptance
>> +or rejection of firmware images by a governing component like an operating
>> +system.
>> +Empty capsules do not require an image-blob input file.
>>
>>   .B mkeficapsule
>>   takes any type of image files when generating non empty capsules, including:
>> --
>> 2.38.1
>>
> 
> BTW as someone else mentioned, this functionality should be in binman too.
> 
> Regards,
> Simon

This program is distributed by Debian/Ubuntu in package u-boot-tools. 
Please, do not remove it.

Binman is not distributed by Debian.

Best regards

Heinrich

Re: [PATCH 1/1] doc: rework doc/mkeficapsule.1

[Simon Glass]

Hi Heinrich,

On Mon, 23 Jan 2023 at 11:50, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> On 1/23/23 19:42, Simon Glass wrote:
> > Hi Heinrich,
> >
> > On Mon, 23 Jan 2023 at 04:24, Heinrich Schuchardt
> > <heinrich.schuchardt@canonical.com> wrote:
> >>
> >> * Indicate the location of the directory for EFI capsules.
> >> * Improve the readability.
> >>
> >> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> >> ---
> >>   doc/mkeficapsule.1 | 21 +++++++++++----------
> >>   1 file changed, 11 insertions(+), 10 deletions(-)
> >>
> >> diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
> >> index 6fb2dd0810..1ca245a10f 100644
> >> --- a/doc/mkeficapsule.1
> >> +++ b/doc/mkeficapsule.1
> >> @@ -11,22 +11,23 @@ mkeficapsule \- Generate EFI capsule file for U-Boot
> >>   .RI [ options ] " " [ image-blob ] " " capsule-file
> >>
> >>   .SH "DESCRIPTION"
> >> +The
> >>   .B mkeficapsule
> >> -command is used to create an EFI capsule file for use with the U-Boot
> >> -EFI capsule update.
> >> -A capsule file may contain various type of firmware blobs which
> >> -are to be applied to the system and must be placed in the specific
> >> -directory on the UEFI system partition.
> >> -An update will be automatically executed at next reboot.
> >> +command is used to create an EFI capsule file to be used by U-Boot for firmware
> >> +updates.
> >> +A capsule file may contain various types of firmware blobs which are to be
> >> +applied to the system.
> >> +If a capsule file is placed in the /EFI/CapusuleUpdate directory of the EFI
> >> +system partition, U-Boot will try to execute the update at the next reboot.
> >>
> >>   Optionally, a capsule file can be signed with a given private key.
> >>   In this case, the update will be authenticated by verifying the signature
> >>   before applying.
> >>
> >> -Additionally, an empty capsule file can be generated for acceptance or
> >> -rejection of firmware images by a governing component like an Operating
> >> -System. The empty capsules do not require an image-blob input file.
> >> -
> >> +Additionally, an empty capsule file can be generated to indicate the acceptance
> >> +or rejection of firmware images by a governing component like an operating
> >> +system.
> >> +Empty capsules do not require an image-blob input file.
> >>
> >>   .B mkeficapsule
> >>   takes any type of image files when generating non empty capsules, including:
> >> --
> >> 2.38.1
> >>
> >
> > BTW as someone else mentioned, this functionality should be in binman too.
> >
> > Regards,
> > Simon
>
> This program is distributed by Debian/Ubuntu in package u-boot-tools.
> Please, do not remove it.

What are you wanting not to remove?

>
> Binman is not distributed by Debian.

Would that be helpful?

Regards,
Simon