summaryrefslogtreecommitdiff
path: root/scripts/atomic/kerneldoc/sub_and_test
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/atomic/kerneldoc/sub_and_test')
-rw-r--r--scripts/atomic/kerneldoc/sub_and_test13
1 files changed, 13 insertions, 0 deletions
diff --git a/scripts/atomic/kerneldoc/sub_and_test b/scripts/atomic/kerneldoc/sub_and_test
new file mode 100644
index 000000000000..d3760f7749d4
--- /dev/null
+++ b/scripts/atomic/kerneldoc/sub_and_test
@@ -0,0 +1,13 @@
+cat <<EOF
+/**
+ * ${class}${atomicname}() - atomic subtract and test if zero with ${desc_order} ordering
+ * @i: ${int} value to add
+ * @v: pointer to ${atomic}_t
+ *
+ * Atomically updates @v to (@v - @i) with ${desc_order} ordering.
+ *
+ * ${desc_noinstr}
+ *
+ * Return: @true if the resulting value of @v is zero, @false otherwise.
+ */
+EOF