diff mbox series

[1/1] efi_loader: function description cmp_pe_section()

Message ID 20200530044721.28137-1-xypron.glpk@gmx.de
State Accepted
Commit 13f62d9f7edf4fe6a63506e83df03f43a9041cba
Headers show
Series [1/1] efi_loader: function description cmp_pe_section() | expand

Commit Message

Heinrich Schuchardt May 30, 2020, 4:47 a.m. UTC 
Rework the description of function cmp_pe_section().

Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
---
 lib/efi_loader/efi_image_loader.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

--
2.26.2
diff mbox series

Patch

diff --git a/lib/efi_loader/efi_image_loader.c b/lib/efi_loader/efi_image_loader.c
index 9078d61980..d03bff8dcd 100644
--- a/lib/efi_loader/efi_image_loader.c
+++ b/lib/efi_loader/efi_image_loader.c
@@ -212,14 +212,16 @@  static void efi_set_code_and_data_type(

 #ifdef CONFIG_EFI_SECURE_BOOT
 /**
- * cmp_pe_section() - compare two sections
- * @arg1:	Pointer to pointer to first section
- * @arg2:	Pointer to pointer to second section
+ * cmp_pe_section() - compare virtual addresses of two PE image sections
+ * @arg1:	pointer to pointer to first section header
+ * @arg2:	pointer to pointer to second section header
  *
- * Compare two sections in PE image.
+ * Compare the virtual addresses of two sections of an portable executable.
+ * The arguments are defined as const void * to allow usage with qsort().
  *
- * Return:	-1, 0, 1 respectively if arg1 < arg2, arg1 == arg2 or
- *		arg1 > arg2
+ * Return:	-1 if the virtual address of arg1 is less than that of arg2,
+ *		0 if the virtual addresses are equal, 1 if the virtual address
+ *		of arg1 is greater than that of arg2.
  */
 static int cmp_pe_section(const void *arg1, const void *arg2)
 {