diff mbox series

[2/2] efi: fix documentation warnings

Message ID 20220525092022.834964-2-vincent.stehle@arm.com
State Accepted, archived
Commit 7751d2ef869e73884e82ef69f4ec61fbe84f1738
Delegated to: Heinrich Schuchardt
Headers show
Series [1/2] doc/efi: add firmware management protocol to the documentation | expand

Commit Message

Vincent Stehlé May 25, 2022, 9:20 a.m. UTC
This fixes the following warnings:

  ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version' not described in 'efi_firmware_fit_get_image_info'
  ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_fit_get_image_info'
  ./lib/efi_loader/efi_firmware.c:369: warning: bad line: firmware image
  ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version' not described in 'efi_firmware_raw_get_image_info'
  ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_raw_get_image_info'

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 lib/efi_loader/efi_firmware.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Heinrich Schuchardt May 25, 2022, 10:07 a.m. UTC | #1
On 5/25/22 11:20, Vincent Stehlé wrote:
> This fixes the following warnings:
>
>    ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version' not described in 'efi_firmware_fit_get_image_info'
>    ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_fit_get_image_info'
>    ./lib/efi_loader/efi_firmware.c:369: warning: bad line: firmware image
>    ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version' not described in 'efi_firmware_raw_get_image_info'
>    ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_raw_get_image_info'
>
> Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>

We don't want to see any build errors when bisecting. Therefore this
match should be merged before patch 1/2.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>   lib/efi_loader/efi_firmware.c | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/lib/efi_loader/efi_firmware.c b/lib/efi_loader/efi_firmware.c
> index 27953fe7699..fe4e084106d 100644
> --- a/lib/efi_loader/efi_firmware.c
> +++ b/lib/efi_loader/efi_firmware.c
> @@ -197,8 +197,8 @@ static efi_status_t efi_fill_image_desc_array(
>    * @descriptor_version:		Pointer to version number
>    * @descriptor_count:		Pointer to number of descriptors
>    * @descriptor_size:		Pointer to descriptor size
> - * package_version:		Package version
> - * package_version_name:	Package version's name
> + * @package_version:		Package version
> + * @package_version_name:	Package version's name
>    *
>    * Return information bout the current firmware image in @image_info.
>    * @image_info will consist of a number of descriptors.
> @@ -296,15 +296,15 @@ const struct efi_firmware_management_protocol efi_fmp_fit = {
>
>   /**
>    * efi_firmware_raw_get_image_info - return information about the current
> -				     firmware image
> + *				     firmware image
>    * @this:			Protocol instance
>    * @image_info_size:		Size of @image_info
>    * @image_info:			Image information
>    * @descriptor_version:		Pointer to version number
>    * @descriptor_count:		Pointer to number of descriptors
>    * @descriptor_size:		Pointer to descriptor size
> - * package_version:		Package version
> - * package_version_name:	Package version's name
> + * @package_version:		Package version
> + * @package_version_name:	Package version's name
>    *
>    * Return information bout the current firmware image in @image_info.
>    * @image_info will consist of a number of descriptors.
diff mbox series

Patch

diff --git a/lib/efi_loader/efi_firmware.c b/lib/efi_loader/efi_firmware.c
index 27953fe7699..fe4e084106d 100644
--- a/lib/efi_loader/efi_firmware.c
+++ b/lib/efi_loader/efi_firmware.c
@@ -197,8 +197,8 @@  static efi_status_t efi_fill_image_desc_array(
  * @descriptor_version:		Pointer to version number
  * @descriptor_count:		Pointer to number of descriptors
  * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
  *
  * Return information bout the current firmware image in @image_info.
  * @image_info will consist of a number of descriptors.
@@ -296,15 +296,15 @@  const struct efi_firmware_management_protocol efi_fmp_fit = {
 
 /**
  * efi_firmware_raw_get_image_info - return information about the current
-				     firmware image
+ *				     firmware image
  * @this:			Protocol instance
  * @image_info_size:		Size of @image_info
  * @image_info:			Image information
  * @descriptor_version:		Pointer to version number
  * @descriptor_count:		Pointer to number of descriptors
  * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
  *
  * Return information bout the current firmware image in @image_info.
  * @image_info will consist of a number of descriptors.