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/arm/mach-exynos/clock.c b/arch/arm/mach-exynos/clock.c
index 99bca54..f91f2ee 100644
--- a/arch/arm/mach-exynos/clock.c
+++ b/arch/arm/mach-exynos/clock.c
@@ -1403,7 +1403,7 @@
* @param target_freq Desired clock frequency in Hz
* @param best_fine_scalar Pointer to store the fine stage divisor
*
- * @return best_main_scalar Main scalar for desired frequency or -1 if none
+ * Return: best_main_scalar Main scalar for desired frequency or -1 if none
* found
*/
static int clock_calc_best_scalar(unsigned int main_scaler_bits,
diff --git a/arch/arm/mach-exynos/clock_init.h b/arch/arm/mach-exynos/clock_init.h
index a4d3fda..8664f10 100644
--- a/arch/arm/mach-exynos/clock_init.h
+++ b/arch/arm/mach-exynos/clock_init.h
@@ -141,7 +141,7 @@
*
* This function can be called from SPL or the main U-Boot.
*
- * @return pointer to the memory timings that we should use
+ * Return: pointer to the memory timings that we should use
*/
struct mem_timings *clock_get_mem_timings(void);
diff --git a/arch/arm/mach-exynos/common_setup.h b/arch/arm/mach-exynos/common_setup.h
index 4e3702b..d7f0223 100644
--- a/arch/arm/mach-exynos/common_setup.h
+++ b/arch/arm/mach-exynos/common_setup.h
@@ -40,7 +40,7 @@
/*
* Init subsystems according to the reset status
*
- * @return 0 for a normal boot, non-zero for a resume
+ * Return: 0 for a normal boot, non-zero for a resume
*/
int do_lowlevel_init(void);
diff --git a/arch/arm/mach-exynos/dmc_init_ddr3.c b/arch/arm/mach-exynos/dmc_init_ddr3.c
index 18c558f..fa867f2 100644
--- a/arch/arm/mach-exynos/dmc_init_ddr3.c
+++ b/arch/arm/mach-exynos/dmc_init_ddr3.c
@@ -253,7 +253,7 @@
* @param ch DMC channel number
* @param byte_lane which DQS byte offset,
* possible values are 0,1,2,3
- * @return TRUE if memory was good, FALSE if not.
+ * Return: TRUE if memory was good, FALSE if not.
*/
static bool dmc_valid_window_test_vector(int ch, int byte_lane)
{
@@ -323,7 +323,7 @@
* representations of 0.
*
* @param b The byte to convert in two's complement.
- * @return The 7-bit value + sign bit.
+ * Return: The 7-bit value + sign bit.
*/
unsigned char make_signed_byte(signed char b)
diff --git a/arch/arm/mach-exynos/exynos5_setup.h b/arch/arm/mach-exynos/exynos5_setup.h
index bf4cca9..af7a5af 100644
--- a/arch/arm/mach-exynos/exynos5_setup.h
+++ b/arch/arm/mach-exynos/exynos5_setup.h
@@ -898,7 +898,7 @@
*
* @param mem Memory timings for this memory type.
* @param reset Reset DDR PHY during initialization.
- * @return 0 if ok, SETUP_ERR_... if there is a problem
+ * Return: 0 if ok, SETUP_ERR_... if there is a problem
*/
int ddr3_mem_ctrl_init(struct mem_timings *mem, int reset);
@@ -913,7 +913,7 @@
* @param phy1_con16 Register address for dmc_phy1->phy_con16
* @param phy0_con17 Register address for dmc_phy0->phy_con17
* @param phy1_con17 Register address for dmc_phy1->phy_con17
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int dmc_config_zq(struct mem_timings *mem, uint32_t *phy0_con16,
uint32_t *phy1_con16, uint32_t *phy0_con17,
diff --git a/arch/arm/mach-exynos/include/mach/clk.h b/arch/arm/mach-exynos/include/mach/clk.h
index 298535d..cf8db21 100644
--- a/arch/arm/mach-exynos/include/mach/clk.h
+++ b/arch/arm/mach-exynos/include/mach/clk.h
@@ -55,7 +55,7 @@
*
* @param peripheral Peripheral id
*
- * @return frequency of the peripheral clk
+ * Return: frequency of the peripheral clk
*/
unsigned long clock_get_periph_rate(int peripheral);
diff --git a/arch/arm/mach-exynos/include/mach/pinmux.h b/arch/arm/mach-exynos/include/mach/pinmux.h
index bd1ad5f..5ef04e7 100644
--- a/arch/arm/mach-exynos/include/mach/pinmux.h
+++ b/arch/arm/mach-exynos/include/mach/pinmux.h
@@ -37,7 +37,7 @@
*
* @param peripheral peripheral to be configured
* @param flags configure flags
- * @return 0 if ok, -1 on error (e.g. unsupported peripheral)
+ * Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
*/
int exynos_pinmux_config(int peripheral, int flags);
@@ -46,7 +46,7 @@
*
* @param blob Device tree blob
* @param node FDT I2C node to find
- * @return peripheral id if ok, PERIPH_ID_NONE on error
+ * Return: peripheral id if ok, PERIPH_ID_NONE on error
*/
int pinmux_decode_periph_id(const void *blob, int node);
#endif
diff --git a/arch/arm/mach-exynos/include/mach/spl.h b/arch/arm/mach-exynos/include/mach/spl.h
index 9d64246..816c852 100644
--- a/arch/arm/mach-exynos/include/mach/spl.h
+++ b/arch/arm/mach-exynos/include/mach/spl.h
@@ -62,7 +62,7 @@
* Validate signature and return a pointer to the parameter table. If the
* signature is invalid, call panic() and never return.
*
- * @return pointer to the parameter table if signature matched or never return.
+ * Return: pointer to the parameter table if signature matched or never return.
*/
struct spl_machine_param *spl_get_machine_params(void);