aboutsummaryrefslogtreecommitdiff
path: root/drivers/core
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /drivers/core
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value. find . -name '*.c' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'drivers/core')
-rw-r--r--drivers/core/acpi.c4
-rw-r--r--drivers/core/device-remove.c2
-rw-r--r--drivers/core/device.c2
-rw-r--r--drivers/core/lists.c2
-rw-r--r--drivers/core/of_access.c2
-rw-r--r--drivers/core/root.c2
-rw-r--r--drivers/core/uclass.c2
7 files changed, 8 insertions, 8 deletions
diff --git a/drivers/core/acpi.c b/drivers/core/acpi.c
index 2176d8b..e988a65 100644
--- a/drivers/core/acpi.c
+++ b/drivers/core/acpi.c
@@ -109,7 +109,7 @@ int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen)
* @dev: Device that generated the data
* @type: Table type it refers to
* @start: The start of the data (the end is obtained from ctx->current)
- * @return 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory
*/
static int acpi_add_item(struct acpi_ctx *ctx, struct udevice *dev,
enum gen_type_t type, void *start)
@@ -179,7 +179,7 @@ static struct acpi_item *find_acpi_item(const char *devname)
* @start: Start position to put the sorted items. The items will follow each
* other in sorted order
* @type: Type of items to sort
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int sort_acpi_item_type(struct acpi_ctx *ctx, void *start,
enum gen_type_t type)
diff --git a/drivers/core/device-remove.c b/drivers/core/device-remove.c
index 69c50da..e6ec6ff 100644
--- a/drivers/core/device-remove.c
+++ b/drivers/core/device-remove.c
@@ -170,7 +170,7 @@ void device_free(struct udevice *dev)
*
* @flags: Flags passed to device_remove()
* @drv_flags: Driver flags
- * @return 0 if the device should be removed,
+ * Return: 0 if the device should be removed,
* -EKEYREJECTED if @flags includes a flag in DM_REMOVE_ACTIVE_ALL but
* @drv_flags does not (indicates that this device has nothing to do for
* DMA shutdown or OS prepare)
diff --git a/drivers/core/device.c b/drivers/core/device.c
index d917d4e..901c1e2 100644
--- a/drivers/core/device.c
+++ b/drivers/core/device.c
@@ -346,7 +346,7 @@ static void *alloc_priv(int size, uint flags)
* device_alloc_priv() - Allocate priv/plat data required by the device
*
* @dev: Device to process
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
static int device_alloc_priv(struct udevice *dev)
{
diff --git a/drivers/core/lists.c b/drivers/core/lists.c
index d2e9dc5..22ccd9f 100644
--- a/drivers/core/lists.c
+++ b/drivers/core/lists.c
@@ -161,7 +161,7 @@ int device_bind_driver_to_node(struct udevice *parent, const char *drv_name,
* @param of_match: List of compatible strings to match
* @param of_idp: Returns the match that was found
* @param compat: The compatible string to search for
- * @return 0 if there is a match, -ENOENT if no match
+ * Return: 0 if there is a match, -ENOENT if no match
*/
static int driver_check_compatible(const struct udevice_id *of_match,
const struct udevice_id **of_idp,
diff --git a/drivers/core/of_access.c b/drivers/core/of_access.c
index 3707143..c20b19c 100644
--- a/drivers/core/of_access.c
+++ b/drivers/core/of_access.c
@@ -463,7 +463,7 @@ struct device_node *of_find_node_by_phandle(phandle handle)
* @propname: name of the property to be searched.
* @len: requested length of property value
*
- * @return the property value on success, -EINVAL if the property does not
+ * Return: the property value on success, -EINVAL if the property does not
* exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
*/
diff --git a/drivers/core/root.c b/drivers/core/root.c
index 815173f..e3f8795 100644
--- a/drivers/core/root.c
+++ b/drivers/core/root.c
@@ -257,7 +257,7 @@ int dm_scan_plat(bool pre_reloc_only)
* @node: Node to scan
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
* flag. If false bind all drivers.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node,
bool pre_reloc_only)
diff --git a/drivers/core/uclass.c b/drivers/core/uclass.c
index 336ea8d..2578803 100644
--- a/drivers/core/uclass.c
+++ b/drivers/core/uclass.c
@@ -46,7 +46,7 @@ struct uclass *uclass_find(enum uclass_id key)
* uclass_add() - Create new uclass in list
* @id: Id number to create
* @ucp: Returns pointer to uclass, or NULL on error
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* The new uclass is added to the list. There must be only one uclass for
* each id.