[PATCH 1/1] efi_loader: improve documentation of enum efi_test_phase

[PATCH 1/1] efi_loader: improve documentation of enum efi_test_phase

[Heinrich Schuchardt]

* Avoid a warning warning: "Incorrect use of kernel-doc format".
* Remove duplicate text.
* Clarify usage of EFI_SETTING_VIRTUAL_ADDRESS_MAP.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 include/efi_selftest.h | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/include/efi_selftest.h b/include/efi_selftest.h
index 07b619901c..94ceb14733 100644
--- a/include/efi_selftest.h
+++ b/include/efi_selftest.h
@@ -53,21 +53,25 @@
  */
 enum efi_test_phase {
 	/**
-	 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: - execute before ExitBootServices
+	 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT:
 	 *
 	 * Setup, execute, and teardown are executed before ExitBootServices().
 	 */
 	EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
 	/**
-	 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: - setup before ExitBootServices
+	 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT:
 	 *
 	 * Setup is executed before ExitBootServices() while execute, and
 	 * teardown are executed after ExitBootServices().
 	 */
 	EFI_SETUP_BEFORE_BOOTTIME_EXIT,
 	/**
-	 * @EFI_SETTING_VIRTUAL_ADDRESS_MAP - calls SetVirtualAddressMap()
-	 * Execute calls SetVirtualAddressMap().
+	 * @EFI_SETTING_VIRTUAL_ADDRESS_MAP:
+	 *
+	 * Execute calls SetVirtualAddressMap(). Setup is executed before
+	 * ExitBootServices() while execute is executed after
+	 * ExitBootServices(), and after the execute of tests marked as
+	 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter.
 	 */
 	EFI_SETTING_VIRTUAL_ADDRESS_MAP,
 };
--
2.30.2

[PATCH 1/1] efi_loader: improve documentation of enum efi_test_phase

[Alex Sadovsky]

Dear Heinrich,
> * Avoid a warning warning: "Incorrect use of kernel-doc format".
> * Remove duplicate text.
> * Clarify usage of EFI_SETTING_VIRTUAL_ADDRESS_MAP.
This is a duplicate text too: `a warning warning'.

[PATCH 1/1] efi_loader: improve documentation of enum efi_test_phase

[Heinrich Schuchardt]

On 28.03.21 15:05, Alex Sadovsky wrote:
> Dear Heinrich,
>> * Avoid a warning warning: "Incorrect use of kernel-doc format".
>> * Remove duplicate text.
>> * Clarify usage of EFI_SETTING_VIRTUAL_ADDRESS_MAP.
> This is a duplicate text too: `a warning warning'.
>

Thanks for reviewing. I will correct the commit message before merging.

Best regards

Heinrich