div64: Correct inline documentation for `do_div'
authorMaciej W. Rozycki <macro@orcam.me.uk>
Tue, 20 Apr 2021 02:50:33 +0000 (04:50 +0200)
committerThomas Bogendoerfer <tsbogend@alpha.franken.de>
Wed, 21 Apr 2021 11:45:36 +0000 (13:45 +0200)
commitf2875832387a25efe7c3be3c5153f3a00e313906
tree3cd5a3df45a063b8e8e437eaf2f4cfb17f1fad95
parent5086ea4b0f58ba72c19553c4a657d7b2c0d8efc2
div64: Correct inline documentation for `do_div'

Correct inline documentation for `do_div', which is a function-like
macro the `n' parameter of which has the semantics of a C++ reference:
it is both read and written in the context of the caller without an
explicit dereference such as with a pointer.

In the C programming language it has no equivalent for proper functions,
in terms of which the documentation expresses the semantics of `do_div',
but substituting a pointer in documentation is misleading, and using the
C++ notation should at least raise the reader's attention and encourage
to seek explanation even if the C++ semantics is not readily understood.

While at it observe that "semantics" is an uncountable noun, so refer to
it with a singular rather than plural verb.

Signed-off-by: Maciej W. Rozycki <macro@orcam.me.uk>
Signed-off-by: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
include/asm-generic/div64.h