diff options
author | Jonathan Corbet <corbet@lwn.net> | 2015-09-14 17:11:05 -0600 |
---|---|---|
committer | Ben Hutchings <ben@decadent.org.uk> | 2019-05-22 23:15:06 +0100 |
commit | 37a585a403b3cd6905d67e8bc70000f3bb90ac48 (patch) | |
tree | e60101a562dc379905b6b73486fcae1b8c7bed56 /include | |
parent | b55c75832bf6c2f672d7f830a4ebefebc271e331 (diff) | |
download | linux-stable-37a585a403b3cd6905d67e8bc70000f3bb90ac48.tar.gz |
locking/static_keys: Fix up the static keys documentation
commit 1975dbc276c6ab62230cf4f9df5ddc9ff0e0e473 upstream.
Fix a few small mistakes in the static key documentation and
delete an unneeded sentence.
Suggested-by: Jason Baron <jbaron@akamai.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Link: http://lkml.kernel.org/r/20150914171105.511e1e21@lwn.net
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Diffstat (limited to 'include')
-rw-r--r-- | include/linux/jump_label.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h index 0684bd3a48fc66..f1094238ab2a0f 100644 --- a/include/linux/jump_label.h +++ b/include/linux/jump_label.h @@ -21,8 +21,8 @@ * * DEFINE_STATIC_KEY_TRUE(key); * DEFINE_STATIC_KEY_FALSE(key); - * static_key_likely() - * static_key_unlikely() + * static_branch_likely() + * static_branch_unlikely() * * Jump labels provide an interface to generate dynamic branches using * self-modifying code. Assuming toolchain and architecture support, if we @@ -45,12 +45,10 @@ * statement, setting the key to true requires us to patch in a jump * to the out-of-line of true branch. * - * In addtion to static_branch_{enable,disable}, we can also reference count + * In addition to static_branch_{enable,disable}, we can also reference count * the key or branch direction via static_branch_{inc,dec}. Thus, * static_branch_inc() can be thought of as a 'make more true' and - * static_branch_dec() as a 'make more false'. The inc()/dec() - * interface is meant to be used exclusively from the inc()/dec() for a given - * key. + * static_branch_dec() as a 'make more false'. * * Since this relies on modifying code, the branch modifying functions * must be considered absolute slow paths (machine wide synchronization etc.). |