diff mbox series

efi_loader: fix sphinx conformance for efi_disk_remove()

Message ID 20230612181758.591854-1-ilias.apalodimas@linaro.org
State New
Headers show
Series efi_loader: fix sphinx conformance for efi_disk_remove() | expand

Commit Message

Ilias Apalodimas June 12, 2023, 6:17 p.m. UTC 
The function does not to conform to the Sphinx style documentation.
Add the missing bits

Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
---
Heinrich, this only applies on top of my rework for the function

 lib/efi_loader/efi_disk.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--
2.39.2
diff mbox series

Patch

diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c
index 62ca8d7fa516..48440221f4f0 100644
--- a/lib/efi_loader/efi_disk.c
+++ b/lib/efi_loader/efi_disk.c
@@ -690,10 +690,10 @@  int efi_disk_probe(void *ctx, struct event *event)
 	return 0;
 }

-/*
- * Delete an efi_disk object for a block device
+/**
+ * efi_disk_remove - Delete an efi_disk object for a block device or partition
  *
- * @dev		uclass device (UCLASS_BLK or UCLASS_PARTITION)
+ * @dev:		uclass device (UCLASS_BLK or UCLASS_PARTITION)
  *
  * Delete an efi_disk object which is associated with @dev.
  * The type of @dev must be either UCLASS_BLK or UCLASS_PARTITION.