locking: Fix up the static keys documentation
Subsystems (2)
Jonathan Corbet
maintainerPATCH 1/1 locking: Fix up the static keys documentation
Fix a few small mistakes in the static key documentation and delete an unneeded sentence.
Suggested-by Jason Baron <[email protected]>
Signed-off-by Jonathan Corbet <[email protected]>
---
This is meant to go on top of my previous patch; I can combine the two if you prefer.
Documentation/static-keys.txt | 4 ++-- include/linux/jump_label.h | 10 ++++------ 2 files changed, 6 insertions(+), 8 deletions(-)
Documentation/static-keys.txt +2 -2
@@ -15,8 +15,8 @@ The updated API replacements are: DEFINE_STATIC_KEY_TRUE(key); DEFINE_STATIC_KEY_FALSE(key); -static_key_likely() -static_key_unlikely() +static_branch_likely() +static_branch_unlikely() 0) Abstract
include/linux/jump_label.h +4 -6
@@ -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.).
Signature · 1 line
2.5.1
tip-bot for Jonathan Corbet
merge bot[tip:locking/urgent] locking/static_keys: Fix up the static keys documentation
locking/static_keys: Fix up the static keys documentation
Commit-ID: 1975dbc276c6ab62230cf4f9df5ddc9ff0e0e473 Gitweb: http://git.kernel.org/tip/1975dbc276c6ab62230cf4f9df5ddc9ff0e0e473 Author: Jonathan Corbet <[email protected]> AuthorDate: Mon, 14 Sep 2015 17:11:05 -0600 Committer: Ingo Molnar <[email protected]> CommitDate: Tue, 15 Sep 2015 07:12:06 +0200
locking/static_keys: Fix up the static keys documentation
Fix a few small mistakes in the static key documentation and delete an unneeded sentence.
Suggested-by Jason Baron <[email protected]>
Signed-off-by Jonathan Corbet <[email protected]>
Cc Linus Torvalds <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Thomas Gleixner <[email protected]>
Signed-off-by Ingo Molnar <[email protected]>
--- Documentation/static-keys.txt | 4 ++-- include/linux/jump_label.h | 10 ++++------ 2 files changed, 6 insertions(+), 8 deletions(-)
Documentation/static-keys.txt +2 -2
@@ -15,8 +15,8 @@ The updated API replacements are: DEFINE_STATIC_KEY_TRUE(key); DEFINE_STATIC_KEY_FALSE(key); -static_key_likely() -static_key_unlikely() +static_branch_likely() +static_branch_unlikely() 0) Abstract
include/linux/jump_label.h +4 -6
@@ -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.).