Commit d28a1de5 authored by Liam Beguin's avatar Liam Beguin Committed by Jonathan Corbet
Browse files

math64: favor kernel-doc from header files 



Fix the kernel-doc markings for div64 functions to point to the header
file instead of the lib/ directory.  This avoids having implementation
specific comments in generic documentation.  Furthermore, given that
some kernel-doc comments are identical, drop them from lib/math64 and
only keep there comments that add implementation details.

Signed-off-by: default avatarLiam Beguin <liambeguin@gmail.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20221118182309.3824530-1-liambeguin@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 1f050e90

Documentation/core-api/kernel-api.rst

+0 −3
Original line number Diff line number Diff line
@@ -165,9 +165,6 @@ Division Functions 
.. kernel-doc:: include/linux/math64.h

   :internal:



.. kernel-doc:: lib/math/div64.c

   :functions: div_s64_rem div64_u64_rem div64_u64 div64_s64



.. kernel-doc:: lib/math/gcd.c

   :export:

include/linux/math64.h

+6 −6
Original line number Diff line number Diff line
@@ -29,7 +29,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
@@ -43,7 +43,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
@@ -57,7 +57,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
@@ -69,7 +69,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
@@ -300,7 +300,7 @@ u64 mul_u64_u64_div_u64(u64 a, u64 mul, u64 div); 
#define DIV64_U64_ROUND_CLOSEST(dividend, divisor)	\

	({ u64 _tmp = (divisor); div64_u64((dividend) + _tmp / 2, _tmp); })



/*

/**

 * DIV_U64_ROUND_CLOSEST - unsigned 64bit divide with 32bit divisor rounded to nearest integer

 * @dividend: unsigned 64bit dividend

 * @divisor: unsigned 32bit divisor
@@ -313,7 +313,7 @@ u64 mul_u64_u64_div_u64(u64 a, u64 mul, u64 div); 
#define DIV_U64_ROUND_CLOSEST(dividend, divisor)	\

	({ u32 _tmp = (divisor); div_u64((u64)(dividend) + _tmp / 2, _tmp); })



/*

/**

 * DIV_S64_ROUND_CLOSEST - signed 64bit divide with 32bit divisor rounded to nearest integer

 * @dividend: signed 64bit dividend

 * @divisor: signed 32bit divisor

lib/math/div64.c

+2 −13
Original line number Diff line number Diff line
@@ -63,12 +63,6 @@ uint32_t __attribute__((weak)) __div64_32(uint64_t *n, uint32_t base) 
EXPORT_SYMBOL(__div64_32);

#endif



/**

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

 * @dividend:	64bit dividend

 * @divisor:	64bit divisor

 * @remainder:  64bit remainder

 */

#ifndef div_s64_rem

s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder)

{
@@ -89,7 +83,7 @@ s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder) 
EXPORT_SYMBOL(div_s64_rem);

#endif



/**

/*

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

 * @dividend:	64bit dividend

 * @divisor:	64bit divisor
@@ -129,7 +123,7 @@ u64 div64_u64_rem(u64 dividend, u64 divisor, u64 *remainder) 
EXPORT_SYMBOL(div64_u64_rem);

#endif



/**

/*

 * div64_u64 - unsigned 64bit divide with 64bit divisor

 * @dividend:	64bit dividend

 * @divisor:	64bit divisor
@@ -163,11 +157,6 @@ u64 div64_u64(u64 dividend, u64 divisor) 
EXPORT_SYMBOL(div64_u64);

#endif



/**

 * div64_s64 - signed 64bit divide with 64bit divisor

 * @dividend:	64bit dividend

 * @divisor:	64bit divisor

 */

#ifndef div64_s64

s64 div64_s64(s64 dividend, s64 divisor)

{