Commit c2a9a645 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

math64.h: kernel-docs: Convert some markups into normal comments 



There are several functions at math64.h that are also
defined at div64.c. As both are included at kernel-api.rst,
Sphinx 3.x complains about symbol duplication:

	./lib/math/div64.c:73: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
	Declaration is 'div_s64_rem'.
	./lib/math/div64.c:104: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
	Declaration is 'div64_u64_rem'.
	./lib/math/div64.c:144: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
	Declaration is 'div64_u64'.
	./lib/math/div64.c:172: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
	Declaration is 'div64_s64'.

In order to avoid Sphinx warnings about duplication, change the kernel-doc
markups to just comments at math64.h.

Reviewed-by: default avatarVincenzo Frascino <vincenzo.frascino@arm.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 5e44635c

include/linux/math64.h

+4 −4
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ static inline u64 div_u64_rem(u64 dividend, u32 divisor, u32 *remainder) 
	return dividend / divisor;

}



/**

/*

 * div_s64_rem - signed 64bit divide with 32bit divisor with remainder

 * @dividend: signed 64bit dividend

 * @divisor: signed 32bit divisor
@@ -42,7 +42,7 @@ static inline s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder) 
	return dividend / divisor;

}



/**

/*

 * div64_u64_rem - unsigned 64bit divide with 64bit divisor and remainder

 * @dividend: unsigned 64bit dividend

 * @divisor: unsigned 64bit divisor
@@ -56,7 +56,7 @@ static inline u64 div64_u64_rem(u64 dividend, u64 divisor, u64 *remainder) 
	return dividend / divisor;

}



/**

/*

 * div64_u64 - unsigned 64bit divide with 64bit divisor

 * @dividend: unsigned 64bit dividend

 * @divisor: unsigned 64bit divisor
@@ -68,7 +68,7 @@ static inline u64 div64_u64(u64 dividend, u64 divisor) 
	return dividend / divisor;

}



/**

/*

 * div64_s64 - signed 64bit divide with 64bit divisor

 * @dividend: signed 64bit dividend

 * @divisor: signed 64bit divisor