All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/1] sandbox: fix documentation of struct host_ops
@ 2022-11-14  9:27 Heinrich Schuchardt
  2022-11-14 22:49 ` Simon Glass
  0 siblings, 1 reply; 2+ messages in thread
From: Heinrich Schuchardt @ 2022-11-14  9:27 UTC (permalink / raw)
  To: Simon Glass; +Cc: u-boot, Heinrich Schuchardt

The documentation of struct host_ops should be Sphinx compliant.

Fixes: 9bd1aa8af2ed ("dm: sandbox: Create a new HOST uclass")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 include/sandbox_host.h | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git a/include/sandbox_host.h b/include/sandbox_host.h
index 2e37ede235..ebd7d99b47 100644
--- a/include/sandbox_host.h
+++ b/include/sandbox_host.h
@@ -23,26 +23,23 @@ struct host_sb_plat {
 
 /**
  * struct host_ops - operations supported by UCLASS_HOST
- *
- * @attach_file: Attach a new file to a device
- * @detach_file: Detach a file from a device
  */
 struct host_ops {
-	/*
-	 * attach_file() - Attach a new file to the device
+	/**
+	 * @attach_file: - Attach a new file to the device
 	 *
-	 * @dev: Device to update
-	 * @filename: Name of the file, e.g. "/path/to/disk.img"
-	 * Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
+	 * @attach_file.dev: Device to update
+	 * @attach_file.filename: Name of the file, e.g. "/path/to/disk.img"
+	 * @attach_file.Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
 	 * other error
 	 */
 	int (*attach_file)(struct udevice *dev, const char *filename);
 
 	/**
-	 * detach_file() - Detach a file from the device
+	 * @detach_file: - Detach a file from the device
 	 *
-	 * @dev: Device to detach from
-	 * Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
+	 * @detach_file.dev: Device to detach from
+	 * @detach_file.Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
 	 * error
 	 */
 	 int (*detach_file)(struct udevice *dev);
-- 
2.37.2


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH 1/1] sandbox: fix documentation of struct host_ops
  2022-11-14  9:27 [PATCH 1/1] sandbox: fix documentation of struct host_ops Heinrich Schuchardt
@ 2022-11-14 22:49 ` Simon Glass
  0 siblings, 0 replies; 2+ messages in thread
From: Simon Glass @ 2022-11-14 22:49 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: u-boot

On Mon, 14 Nov 2022 at 02:28, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> The documentation of struct host_ops should be Sphinx compliant.
>
> Fixes: 9bd1aa8af2ed ("dm: sandbox: Create a new HOST uclass")
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  include/sandbox_host.h | 19 ++++++++-----------
>  1 file changed, 8 insertions(+), 11 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2022-11-14 22:50 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-14  9:27 [PATCH 1/1] sandbox: fix documentation of struct host_ops Heinrich Schuchardt
2022-11-14 22:49 ` Simon Glass

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.