Commit e8e4eb0f authored by Jonathan Neuschäfer's avatar Jonathan Neuschäfer Committed by Thomas Gleixner

asm-generic/div64: Fix documentation of do_div() parameter

Contrary to the description, the first parameter (n) should not be passed
as a pointer, but directly as an lvalue. This is possible because do_div() is
a macro.
Signed-off-by: default avatarJonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Reviewed-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Link: https://lkml.kernel.org/r/20190808181948.27659-1-j.neuschaefer@gmx.net
parent a55aa89a
...@@ -28,12 +28,12 @@ ...@@ -28,12 +28,12 @@
/** /**
* do_div - returns 2 values: calculate remainder and update new dividend * do_div - returns 2 values: calculate remainder and update new dividend
* @n: pointer to uint64_t dividend (will be updated) * @n: uint64_t dividend (will be updated)
* @base: uint32_t divisor * @base: uint32_t divisor
* *
* Summary: * Summary:
* ``uint32_t remainder = *n % base;`` * ``uint32_t remainder = n % base;``
* ``*n = *n / base;`` * ``n = n / base;``
* *
* Return: (uint32_t)remainder * Return: (uint32_t)remainder
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment