xref: /linux/scripts/atomic/kerneldoc/sub_and_test (revision 36ec807b627b4c0a0a382f0ae48eac7187d14b2b)
1ad811070SMark Rutlandcat <<EOF
2ad811070SMark Rutland/**
3ad811070SMark Rutland * ${class}${atomicname}() - atomic subtract and test if zero with ${desc_order} ordering
4*f92a59f6SCarlos Llamas * @i: ${int} value to subtract
5ad811070SMark Rutland * @v: pointer to ${atomic}_t
6ad811070SMark Rutland *
7ad811070SMark Rutland * Atomically updates @v to (@v - @i) with ${desc_order} ordering.
8ad811070SMark Rutland *
9ad811070SMark Rutland * ${desc_noinstr}
10ad811070SMark Rutland *
11ad811070SMark Rutland * Return: @true if the resulting value of @v is zero, @false otherwise.
12ad811070SMark Rutland */
13ad811070SMark RutlandEOF
14