summaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /scripts
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
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 'scripts')
-rw-r--r--scripts/dtc/libfdt/fdt_rw.c2
-rw-r--r--scripts/dtc/libfdt/libfdt.h4
-rw-r--r--scripts/dtc/srcpos.c4
-rw-r--r--scripts/dtc/srcpos.h2
-rw-r--r--scripts/dtc/util.h12
5 files changed, 12 insertions, 12 deletions
diff --git a/scripts/dtc/libfdt/fdt_rw.c b/scripts/dtc/libfdt/fdt_rw.c
index 08e2981a44..2eb2b38703 100644
--- a/scripts/dtc/libfdt/fdt_rw.c
+++ b/scripts/dtc/libfdt/fdt_rw.c
@@ -123,7 +123,7 @@ static int fdt_splice_string_(void *fdt, int newlen)
* @s: string to find/add
* @allocated: Set to 0 if the string was found, 1 if not found and so
* allocated. Ignored if !fdt_chk_basic()
- * @return offset of string in the string table (whether found or added)
+ * Return: offset of string in the string table (whether found or added)
*/
static int fdt_find_add_string_(void *fdt, const char *s, int *allocated)
{
diff --git a/scripts/dtc/libfdt/libfdt.h b/scripts/dtc/libfdt/libfdt.h
index 421f90ad93..d706f85962 100644
--- a/scripts/dtc/libfdt/libfdt.h
+++ b/scripts/dtc/libfdt/libfdt.h
@@ -152,7 +152,7 @@ int fdt_next_node(const void *fdt, int offset, int *depth);
*
* @fdt: FDT blob
* @offset: Offset of node to check
- * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
+ * Return: offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
*/
int fdt_first_subnode(const void *fdt, int offset);
@@ -164,7 +164,7 @@ int fdt_first_subnode(const void *fdt, int offset);
*
* @fdt: FDT blob
* @offset: Offset of previous subnode
- * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
+ * Return: offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
* subnodes
*/
int fdt_next_subnode(const void *fdt, int offset);
diff --git a/scripts/dtc/srcpos.c b/scripts/dtc/srcpos.c
index cb6ed0e3e5..c297861145 100644
--- a/scripts/dtc/srcpos.c
+++ b/scripts/dtc/srcpos.c
@@ -66,7 +66,7 @@ static int srcfile_depth; /* = 0 */
* @param dirname Directory to look in, or NULL for none
* @param fname Filename to look for
* @param fp Set to NULL if file did not open
- * @return allocated filename on success (caller must free), NULL on failure
+ * Return: allocated filename on success (caller must free), NULL on failure
*/
static char *try_open(const char *dirname, const char *fname, FILE **fp)
{
@@ -93,7 +93,7 @@ static char *try_open(const char *dirname, const char *fname, FILE **fp)
*
* @param fname Filename to open
* @param fp Returns pointer to opened FILE, or NULL on failure
- * @return pointer to allocated filename, which caller must free
+ * Return: pointer to allocated filename, which caller must free
*/
static char *fopen_any_on_path(const char *fname, FILE **fp)
{
diff --git a/scripts/dtc/srcpos.h b/scripts/dtc/srcpos.h
index 9ded12a383..5db32a723e 100644
--- a/scripts/dtc/srcpos.h
+++ b/scripts/dtc/srcpos.h
@@ -52,7 +52,7 @@ extern struct srcfile_state *current_srcfile; /* = NULL */
* @param fullnamep If non-NULL, it is set to the allocated filename of the
* file that was opened. The caller is then responsible
* for freeing the pointer.
- * @return pointer to opened FILE
+ * Return: pointer to opened FILE
*/
FILE *srcfile_relative_open(const char *fname, char **fullnamep);
diff --git a/scripts/dtc/util.h b/scripts/dtc/util.h
index 66fba8ea70..211d584435 100644
--- a/scripts/dtc/util.h
+++ b/scripts/dtc/util.h
@@ -81,7 +81,7 @@ extern char *join_path(const char *path, const char *name);
*
* @param data The string to check
* @param len The string length including terminator
- * @return 1 if a valid printable string, 0 if not
+ * Return: 1 if a valid printable string, 0 if not
*/
bool util_is_printable_string(const void *data, int len);
@@ -98,7 +98,7 @@ char get_escape_char(const char *s, int *i);
* stderr.
*
* @param filename The filename to read, or - for stdin
- * @return Pointer to allocated buffer containing fdt, or NULL on error
+ * Return: Pointer to allocated buffer containing fdt, or NULL on error
*/
char *utilfdt_read(const char *filename);
@@ -116,7 +116,7 @@ char *utilfdt_read_len(const char *filename, off_t *len);
*
* @param filename The filename to read, or - for stdin
* @param buffp Returns pointer to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_read_err(const char *filename, char **buffp);
@@ -133,7 +133,7 @@ int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int utilfdt_write(const char *filename, const void *blob);
@@ -144,7 +144,7 @@ int utilfdt_write(const char *filename, const void *blob);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_write_err(const char *filename, const void *blob);
@@ -169,7 +169,7 @@ int utilfdt_write_err(const char *filename, const void *blob);
* @param fmt Format string to process
* @param type Returns type found(s/d/u/x), or 0 if none
* @param size Returns size found(1,2,4,8) or 4 if none
- * @return 0 if ok, -1 on error (no type given, or other invalid format)
+ * Return: 0 if ok, -1 on error (no type given, or other invalid format)
*/
int utilfdt_decode_type(const char *fmt, int *type, int *size);