linux-kernel - [PATCH -next] static-keys: Fix documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20150825065427.4f09b7b2@as>
Date:	Tue, 25 Aug 2015 06:54:27 -0400
From:	Chuck Ebbert <cebbert.lkml@...il.com>
To:	Peter Zijlstra <peterz@...radead.org>
Cc:	linux-kernel@...r.kernel.org
Subject: [PATCH -next] static-keys: Fix documentation

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

Signed-off-by: Chuck Ebbert <cebbert.lkml@...il.com>

diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
index f4cb0b2..127391c 100644
--- a/Documentation/static-keys.txt
+++ b/Documentation/static-keys.txt
@@ -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
 
diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
index 7f653e8..dd89266 100644
--- a/include/linux/jump_label.h
+++ b/include/linux/jump_label.h
@@ -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;
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/