* [PATCH 1/1] smbios: convert function descriptions to Sphinx style
@ 2021-06-10 10:15 Heinrich Schuchardt
2021-07-05 15:55 ` Simon Glass
0 siblings, 1 reply; 2+ messages in thread
From: Heinrich Schuchardt @ 2021-06-10 10:15 UTC (permalink / raw)
To: Simon Glass; +Cc: u-boot, Bin Meng, Christian Gmeiner, Heinrich Schuchardt
Use 'Return:' instead of '@return:'.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
lib/smbios.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/lib/smbios.c b/lib/smbios.c
index 9eb226ec9f..26df2bf123 100644
--- a/lib/smbios.c
+++ b/lib/smbios.c
@@ -47,7 +47,7 @@ struct smbios_ctx {
* @addr: start address to write the structure
* @handle: the structure's handle, a unique 16-bit number
* @ctx: context for writing the tables
- * @return: size of the structure
+ * Return: size of the structure
*/
typedef int (*smbios_write_type)(ulong *addr, int handle,
struct smbios_ctx *ctx);
@@ -72,7 +72,7 @@ struct smbios_write_method {
*
* @ctx: SMBIOS context
* @str: string to add
- * @return: string number in the string area (1 or more)
+ * Return: string number in the string area (1 or more)
*/
static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
{
@@ -111,7 +111,7 @@ static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
*
* @ctx: context for writing the tables
* @prop: property to write
- * @return 0 if not found, else SMBIOS string number (1 or more)
+ * Return: 0 if not found, else SMBIOS string number (1 or more)
*/
static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
int sysinfo_id)
@@ -139,7 +139,7 @@ static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
* smbios_add_prop() - Add a property from the devicetree
*
* @prop: property to write
- * @return 0 if not found, else SMBIOS string number (1 or more)
+ * Return: 0 if not found, else SMBIOS string number (1 or more)
*/
static int smbios_add_prop(struct smbios_ctx *ctx, const char *prop)
{
@@ -187,7 +187,7 @@ int smbios_update_version(const char *version)
* This computes the size of the string area including the string terminator.
*
* @ctx: SMBIOS context
- * @return: string area size
+ * Return: string area size
*/
static int smbios_string_table_len(const struct smbios_ctx *ctx)
{
--
2.30.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH 1/1] smbios: convert function descriptions to Sphinx style
2021-06-10 10:15 [PATCH 1/1] smbios: convert function descriptions to Sphinx style Heinrich Schuchardt
@ 2021-07-05 15:55 ` Simon Glass
0 siblings, 0 replies; 2+ messages in thread
From: Simon Glass @ 2021-07-05 15:55 UTC (permalink / raw)
To: Heinrich Schuchardt; +Cc: U-Boot Mailing List, Bin Meng, Christian Gmeiner
On Thu, 10 Jun 2021 at 04:15, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Use 'Return:' instead of '@return:'.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> lib/smbios.c | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
Reviewed-by: Simon Glass <sjg@chromium.org>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-07-05 15:56 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-10 10:15 [PATCH 1/1] smbios: convert function descriptions to Sphinx style Heinrich Schuchardt
2021-07-05 15:55 ` 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.