diff options
author | Mark Rutland <mark.rutland@arm.com> | 2023-06-05 10:01:21 +0300 |
---|---|---|
committer | Peter Zijlstra <peterz@infradead.org> | 2023-06-05 10:57:23 +0300 |
commit | 8aaf297a0dd66d4fac215af24ece8dea091079bc (patch) | |
tree | 4c450d5c02058465959d0d75bbe9eb121ee2d618 /include/linux/atomic/atomic-instrumented.h | |
parent | 1d78814d41701c216e28fcf2656526146dec4a1a (diff) | |
download | linux-8aaf297a0dd66d4fac215af24ece8dea091079bc.tar.xz |
docs: scripts: kernel-doc: accept bitwise negation like ~@var
In some cases we'd like to indicate the bitwise negation of a parameter,
e.g.
~@var
This will be helpful for describing the atomic andnot operations, where
we'd like to write comments of the form:
Atomically updates @v to (@v & ~@i)
Which kernel-doc currently transforms to:
Atomically updates **v** to (**v** & ~**i**)
Rather than the preferable form:
Atomically updates **v** to (**v** & **~i**)
This is similar to what we did for '!@var' in commit:
ee2aa7590398 ("scripts: kernel-doc: accept negation like !@var")
This patch follows the same pattern that commit used to permit a '!'
prefix on a param ref, allowing a '~' prefix on a param ref, cuasing
kernel-doc to generate the preferred form above.
Suggested-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lore.kernel.org/r/20230605070124.3741859-25-mark.rutland@arm.com
Diffstat (limited to 'include/linux/atomic/atomic-instrumented.h')
0 files changed, 0 insertions, 0 deletions