static-keys: Fix documentation

PATCH New Chuck Ebbert 1 participant 1 message Aug 25, 2015

Subsystems (2)

Documentation Static branch/call

lore

Share & tools

lore

Chuck Ebbert

author

2015-08-25 10:54 UTC #0 lore raw

PATCH 1/1 static-keys: Fix documentation

Fix some mistakes and typos, clean up text a bit.

Signed-off-by Chuck Ebbert <[email protected]>

Documentation/static-keys.txt +4 -4

index f4cb0b2..127391c 100644
@@ -3,8 +3,8 @@
 
 DEPRECATED API:
 
-The use of 'struct static_key' directly, is now DEPRECATED. In addition
-static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following:
+The use of 'struct static_key' directly is now DEPRECATED. In addition
+static_key_{true,false}() is also DEPRECATED. I.e. DO NOT use the following:
 
 struct static_key false = STATIC_KEY_INIT_FALSE;
 struct static_key true = STATIC_KEY_INIT_TRUE;

@@ -15,8 +15,8 @@ The updated API replacements are:
 
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
-static_key_likely()
-statick_key_unlikely()
+static_branch_likely()
+static_branch_unlikely()
 
 0) Abstract

include/linux/jump_label.h +5 -5

index 7f653e8..dd89266 100644
@@ -9,8 +9,8 @@
  *
  * DEPRECATED API:
  *
- * The use of 'struct static_key' directly, is now DEPRECATED. In addition
- * static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following:
+ * The use of 'struct static_key' directly is now DEPRECATED. In addition
+ * static_key_{true,false}() is also DEPRECATED. I.e. DO NOT use the following:
  *
  * struct static_key false = STATIC_KEY_INIT_FALSE;
  * struct static_key true = STATIC_KEY_INIT_TRUE;

@@ -21,8 +21,8 @@
  *
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
- * static_key_likely()
- * statick_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

@@ -90,7 +90,7 @@ extern bool static_key_initialized;
 
 struct static_key {
 	atomic_t enabled;
-/* Set lsb bit to 1 if branch is default true, 0 ot */
+/* Set lsb to 1 if branch is default true, 0 otherwise */
 	struct jump_entry *entries;
 #ifdef CONFIG_MODULES
 	struct static_key_mod *next;