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/arch/x86/cpu/apollolake/fsp_bindings.c b/arch/x86/cpu/apollolake/fsp_bindings.c
index 319c78b..fb75e1f 100644
--- a/arch/x86/cpu/apollolake/fsp_bindings.c
+++ b/arch/x86/cpu/apollolake/fsp_bindings.c
@@ -44,7 +44,7 @@
* Set to 0 if the property is expected to be a scalar
* @dst: Pointer to destination of where to save the value(s) read
* from devicetree
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
static int read_u16_prop(ofnode node, char *name, size_t count, u16 *dst)
{
@@ -196,7 +196,7 @@
* @fsp_bindings: Binding describing which devicetree properties should
* be stored where in the FSP configuration structure
* The end of the list is declared by a NULL pointer in propname
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP from the provided
* devicetree node and saves it in the FSP configuration structure.
diff --git a/arch/x86/cpu/broadwell/pch.c b/arch/x86/cpu/broadwell/pch.c
index f012db9..37fcddb 100644
--- a/arch/x86/cpu/broadwell/pch.c
+++ b/arch/x86/cpu/broadwell/pch.c
@@ -522,7 +522,7 @@
/**
* pch_serialio_init() - set up serial I/O devices
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int pch_serialio_init(void)
{
diff --git a/arch/x86/cpu/broadwell/refcode.c b/arch/x86/cpu/broadwell/refcode.c
index 6c04dde..aced3e5 100644
--- a/arch/x86/cpu/broadwell/refcode.c
+++ b/arch/x86/cpu/broadwell/refcode.c
@@ -65,7 +65,7 @@
* platform controller hub (PCH). This function should be implemented by the
* CPU-specific code.
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
static int cpu_run_reference_code(void)
{
diff --git a/arch/x86/cpu/intel_common/lpc.c b/arch/x86/cpu/intel_common/lpc.c
index f31fddb..af68c0f 100644
--- a/arch/x86/cpu/intel_common/lpc.c
+++ b/arch/x86/cpu/intel_common/lpc.c
@@ -39,7 +39,7 @@
* lpc_early_init() - set up LPC serial ports and other early things
*
* @dev: LPC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int lpc_common_early_init(struct udevice *dev)
{
diff --git a/arch/x86/cpu/intel_common/p2sb.c b/arch/x86/cpu/intel_common/p2sb.c
index 5a7b30d..e4e53f7 100644
--- a/arch/x86/cpu/intel_common/p2sb.c
+++ b/arch/x86/cpu/intel_common/p2sb.c
@@ -46,7 +46,7 @@
* This is needed by FSP-M which uses the High Precision Event Timer.
*
* @dev: P2SB device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int p2sb_early_init(struct udevice *dev)
{
diff --git a/arch/x86/cpu/ivybridge/bd82x6x.c b/arch/x86/cpu/ivybridge/bd82x6x.c
index 0540b02..89312a8 100644
--- a/arch/x86/cpu/ivybridge/bd82x6x.c
+++ b/arch/x86/cpu/ivybridge/bd82x6x.c
@@ -39,7 +39,7 @@
* pch_silicon_revision() - Read silicon revision ID from the PCH
*
* @dev: PCH device
- * @return silicon revision ID
+ * Return: silicon revision ID
*/
static int pch_silicon_revision(struct udevice *dev)
{
@@ -71,7 +71,7 @@
* @dev: PCH device
* @type: PCH type
* @rev: Minimum required resion
- * @return 0 if not supported, 1 if supported
+ * Return: 0 if not supported, 1 if supported
*/
static int pch_silicon_supported(struct udevice *dev, int type, int rev)
{
diff --git a/arch/x86/cpu/mp_init.c b/arch/x86/cpu/mp_init.c
index c09762a..7637c9b 100644
--- a/arch/x86/cpu/mp_init.c
+++ b/arch/x86/cpu/mp_init.c
@@ -423,7 +423,7 @@
*
* @num_aps: Number of APs we expect to find
* @ap_count: Initially zero. Incremented by this function for each AP found
- * @return 0 if all APs were set up correctly or there are none to set up,
+ * Return: 0 if all APs were set up correctly or there are none to set up,
* -ENOSPC if the SIPI vector is too high in memory,
* -ETIMEDOUT if the ICR is busy or the second SIPI fails to complete
* -EIO if not all APs check in correctly
@@ -536,7 +536,7 @@
*
* @devp: If non-NULL, returns CPU device corresponding to the BSP
* @cpu_countp: If non-NULL, returns the total number of CPUs
- * @return CPU number of the BSP, or -ve on error. If multiprocessing is not
+ * Return: CPU number of the BSP, or -ve on error. If multiprocessing is not
* enabled, returns 0
*/
static int get_bsp(struct udevice **devp, int *cpu_countp)
@@ -573,7 +573,7 @@
* pointer to new instructions
*
* @slot: Pointer to the AP's callback slot
- * @return value of that pointer
+ * Return: value of that pointer
*/
static struct mp_callback *read_callback(struct mp_callback **slot)
{
@@ -610,7 +610,7 @@
* @num_cpus: The number of CPUs in the system (= number of APs + 1)
* @expire_ms: Timeout to wait for all APs to finish, in milliseconds, or 0 for
* no timeout
- * @return 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time
+ * Return: 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time
*/
static int run_ap_work(struct mp_callback *callback, struct udevice *bsp,
int num_cpus, uint expire_ms)
@@ -670,7 +670,7 @@
*
* @cpu: CPU that is waiting
* @unused: Optional argument provided by struct mp_flight_record, not used here
- * @return Does not return
+ * Return: Does not return
*/
static int ap_wait_for_instruction(struct udevice *cpu, void *unused)
{
diff --git a/arch/x86/cpu/mtrr.c b/arch/x86/cpu/mtrr.c
index 260a008..e69dfb5 100644
--- a/arch/x86/cpu/mtrr.c
+++ b/arch/x86/cpu/mtrr.c
@@ -109,7 +109,7 @@
/**
* mtrr_copy_to_aps() - Copy the MTRRs from the boot CPU to other CPUs
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
static int mtrr_copy_to_aps(void)
{
diff --git a/arch/x86/cpu/slimbootloader/sdram.c b/arch/x86/cpu/slimbootloader/sdram.c
index 36d0d4d..c6f10e2 100644
--- a/arch/x86/cpu/slimbootloader/sdram.c
+++ b/arch/x86/cpu/slimbootloader/sdram.c
@@ -46,7 +46,7 @@
* The memory map entries from Slim Bootloader hob are already sorted.
*
* @total_size: The memory size that u-boot occupies
- * @return : The top available memory address lower than 4GB
+ * Return: : The top available memory address lower than 4GB
*/
ulong board_get_usable_ram_top(ulong total_size)
{