[tip: core/headers] asm-generic/div64: Fix documentation of do_div() parameter

[tip-bot2 for Jonathan NeuschÃfer]

The following commit has been merged into the core/headers branch of tip:

Commit-ID:     e8e4eb0fbeda570b16464208aebf5caccfb6eb95
Gitweb:        https://git.kernel.org/tip/e8e4eb0fbeda570b16464208aebf5caccfb6eb95
Author:        Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx>
AuthorDate:    Thu, 08 Aug 2019 20:19:48 +02:00
Committer:     Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Wed, 28 Aug 2019 16:38:46 +02:00

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: Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Reviewed-by: Geert Uytterhoeven <geert+renesas@xxxxxxxxx>
Link: https://lkml.kernel.org/r/20190808181948.27659-1-j.neuschaefer@xxxxxxx

---
 include/asm-generic/div64.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/asm-generic/div64.h b/include/asm-generic/div64.h
index dc9726f..b2a9c74 100644
--- a/include/asm-generic/div64.h
+++ b/include/asm-generic/div64.h
@@ -28,12 +28,12 @@
 
 /**
  * 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
  *
  * Summary:
- * ``uint32_t remainder = *n % base;``
- * ``*n = *n / base;``
+ * ``uint32_t remainder = n % base;``
+ * ``n = n / base;``
  *
  * Return: (uint32_t)remainder
  *