efi_loader: improve documentation of enum efi_test_phase
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Sun, 28 Mar 2021 08:41:00 +0000 (10:41 +0200)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 10 Apr 2021 10:00:24 +0000 (12:00 +0200)
* Avoid a 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

index 07b6199..94ceb14 100644 (file)
  */
 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,
 };