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>
diff --git a/cmd/mtdparts.c b/cmd/mtdparts.c
index 3048700..bab75a2 100644
--- a/cmd/mtdparts.c
+++ b/cmd/mtdparts.c
@@ -170,7 +170,7 @@
*
* @param ptr where parse begins
* @param retptr output pointer to next char after parse completes (output)
- * @return resulting unsigned int
+ * Return: resulting unsigned int
*/
static u64 memsize_parse (const char *const ptr, const char **retptr)
{
@@ -302,7 +302,7 @@
* @param type mtd type
* @param num mtd number
* @param mtd a pointer to an mtd_info instance (output)
- * @return 0 if device is valid, 1 otherwise
+ * Return: 0 if device is valid, 1 otherwise
*/
static int get_mtd_info(u8 type, u8 num, struct mtd_info **mtd)
{
@@ -326,7 +326,7 @@
*
* @param id of the parent device
* @param part partition to validate
- * @return 0 if partition is valid, 1 otherwise
+ * Return: 0 if partition is valid, 1 otherwise
*/
static int part_validate_eraseblock(struct mtdids *id, struct part_info *part)
{
@@ -413,7 +413,7 @@
*
* @param id of the parent device
* @param part partition to validate
- * @return 0 if partition is valid, 1 otherwise
+ * Return: 0 if partition is valid, 1 otherwise
*/
static int part_validate(struct mtdids *id, struct part_info *part)
{
@@ -449,7 +449,7 @@
*
* @param dev device to delete partition from
* @param part partition to delete
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_del(struct mtd_device *dev, struct part_info *part)
{
@@ -577,7 +577,7 @@
*
* @param dev device to which partition is added
* @param part partition to be added
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_add(struct mtd_device *dev, struct part_info *part)
{
@@ -599,7 +599,7 @@
* @param partdef pointer to the partition definition string i.e. <part-def>
* @param ret output pointer to next char after parse completes (output)
* @param retpart pointer to the allocated partition (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_parse(const char *const partdef, const char **ret, struct part_info **retpart)
{
@@ -717,7 +717,7 @@
* @param type mtd type
* @param num mtd number
* @param size a pointer to the size of the mtd device (output)
- * @return 0 if device is valid, 1 otherwise
+ * Return: 0 if device is valid, 1 otherwise
*/
static int mtd_device_validate(u8 type, u8 num, u64 *size)
{
@@ -735,7 +735,7 @@
* Delete all mtd devices from a supplied devices list, free memory allocated for
* each device and delete all device partitions.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_delall(struct list_head *head)
{
@@ -759,7 +759,7 @@
* from device list and device memory is freed.
*
* @param dev device to be deleted
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_del(struct mtd_device *dev)
{
@@ -791,7 +791,7 @@
*
* @param type device type
* @param num device number
- * @return NULL if requested device does not exist
+ * Return: NULL if requested device does not exist
*/
struct mtd_device *device_find(u8 type, u8 num)
{
@@ -838,7 +838,7 @@
* @param mtd_dev pointer to the device definition string i.e. <mtd-dev>
* @param ret output pointer to next char after parse completes (output)
* @param retdev pointer to the allocated device (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_parse(const char *const mtd_dev, const char **ret, struct mtd_device **retdev)
{
@@ -969,7 +969,7 @@
/**
* Initialize global device list.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int mtd_devices_init(void)
{
@@ -983,7 +983,7 @@
/*
* Search global mtdids list and find id of requested type and number.
*
- * @return pointer to the id if it exists, NULL otherwise
+ * Return: pointer to the id if it exists, NULL otherwise
*/
static struct mtdids* id_find(u8 type, u8 num)
{
@@ -1007,7 +1007,7 @@
*
* @param mtd_id string containing requested mtd_id
* @param mtd_id_len length of supplied mtd_id
- * @return pointer to the id if it exists, NULL otherwise
+ * Return: pointer to the id if it exists, NULL otherwise
*/
static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_len)
{
@@ -1040,7 +1040,7 @@
* @param ret_id output pointer to next char after parse completes (output)
* @param dev_type parsed device type (output)
* @param dev_num parsed device number (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type,
u8 *dev_num)
@@ -1082,7 +1082,7 @@
*
* @param buf output buffer holding generated mtdparts string (output)
* @param buflen buffer size
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int generate_mtdparts(char *buf, u32 buflen)
{
@@ -1207,7 +1207,7 @@
*
* @param buf output buffer holding generated mtdparts string (output)
* @param buflen buffer size
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int generate_mtdparts_save(char *buf, u32 buflen)
{
@@ -1229,7 +1229,7 @@
*
* @param mtd the mtd info
* @param part the partition
- * @return the calculated net size of this partition
+ * Return: the calculated net size of this partition
*/
static uint64_t net_part_size(struct mtd_info *mtd, struct part_info *part)
{
@@ -1345,7 +1345,7 @@
* @param dev pointer to the requested device (output)
* @param part_num verified partition number (output)
* @param part pointer to requested partition (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int find_dev_and_part(const char *id, struct mtd_device **dev,
u8 *part_num, struct part_info **part)
@@ -1405,7 +1405,7 @@
* Find and delete partition. For partition id format see find_dev_and_part().
*
* @param id string describing device and partition
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int delete_partition(const char *id)
{
@@ -1481,7 +1481,7 @@
* as big as their mtdparts environment variable sizes and they each start
* on a good block.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int spread_partitions(void)
{
@@ -1534,7 +1534,7 @@
* buffer. gd->env_buf will be too small.
*
* @param buf temporary buffer pointer MTDPARTS_MAXLEN long
- * @return mtdparts variable string, NULL if not found
+ * Return: mtdparts variable string, NULL if not found
*/
static const char *env_get_mtdparts(char *buf)
{
@@ -1550,7 +1550,7 @@
* for each entry. Add created devices to the global devices list.
*
* @param mtdparts string specifing mtd partitions
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int parse_mtdparts(const char *const mtdparts)
{
@@ -1608,7 +1608,7 @@
* to the global mtdids list.
*
* @param ids mapping string
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int parse_mtdids(const char *const ids)
{
@@ -1718,7 +1718,7 @@
* Parse and initialize global mtdids mapping and create global
* device/partition list.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int mtdparts_init(void)
{
@@ -1868,7 +1868,7 @@
*
* @param dev device that is to be searched for a partition
* @param part_num requested partition number
- * @return pointer to the part_info, NULL otherwise
+ * Return: pointer to the part_info, NULL otherwise
*/
static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part_num)
{
@@ -1915,7 +1915,7 @@
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int do_chpart(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
@@ -1954,7 +1954,7 @@
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int do_mtdparts(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])