Skip to contentSkip to conversation

locking/static_keys: fix a silly typo

PATCH In review Jonathan Corbet 5 participants 7 messages Sep 7, 2015 – Sep 17, 2015

Subsystems (2)
lore
Share & tools
lore

Jonathan Corbet

author maintainer
#0 lore raw

PATCH 1/1 locking/static_keys: fix a silly typo

412758cb2670 (jump label, locking/static_keys: Update docs) introduced a typo that might as well get fixed.

---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +1 -1
index f4cb0b2..ec91158 100644
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()
 
 0) Abstract
 
include/linux/jump_label.h +1 -1
index 7f653e8..0684bd3 100644
@@ -22,7 +22,7 @@
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
  * static_key_likely()
- * statick_key_unlikely()
+ * static_key_unlikely()
  *
  * Jump labels provide an interface to generate dynamic branches using
  * self-modifying code. Assuming toolchain and architecture support, if we
Signature · 1 line
2.5.1
#1 lore raw
Quoted 14 lines · Jonathan Corbet

412758cb2670 (jump label, locking/static_keys: Update docs) introduced a typo that might as well get fixed.

---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +0 -0
index f4cb0b2..ec91158 100644

Documentation/static-keys.txt The updated API replacements are: · line 19

Quoted 5 lines
Documentation/static-keys.txt +1 -1
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()

Thancks, applied!

Ingo

#2 lore raw

[tip:locking/urgent] locking/static_keys: Fix a silly typo

In reply to Jonathan Corbet
locking/static_keys: Fix a silly typo
Commit-ID:  edcd591c77a48da753456f92daf8bb50fe9bac93
Gitweb:     http://git.kernel.org/tip/edcd591c77a48da753456f92daf8bb50fe9bac93
Author:     Jonathan Corbet <[email protected]>
AuthorDate: Mon, 7 Sep 2015 13:18:03 -0600
Committer:  Ingo Molnar <[email protected]>
CommitDate: Tue, 8 Sep 2015 09:02:17 +0200

locking/static_keys: Fix a silly typo

Commit:

412758cb2670 ("jump label, locking/static_keys: Update docs")

introduced a typo that might as well get fixed.

Cc Andrew Morton <[email protected]>
Cc Jason Baron <[email protected]>
Cc Linus Torvalds <[email protected]>
Cc Paul E. McKenney <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Thomas Gleixner <[email protected]>
---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +1 -1
index f4cb0b2..ec91158 100644
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()
 
 0) Abstract
 
include/linux/jump_label.h +1 -1
index 7f653e8..0684bd3 100644
@@ -22,7 +22,7 @@
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
  * static_key_likely()
- * statick_key_unlikely()
+ * static_key_unlikely()
  *
  * Jump labels provide an interface to generate dynamic branches using
  * self-modifying code. Assuming toolchain and architecture support, if we
maintainer
#3 lore raw
In reply to Jonathan Corbet
Quoted 28 lines · Jonathan Corbet

412758cb2670 (jump label, locking/static_keys: Update docs) introduced a typo that might as well get fixed.

---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +1 -1
index f4cb0b2..ec91158 100644
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()
 
 0) Abstract
 
include/linux/jump_label.h +0 -0
index 7f653e8..0684bd3 100644

include/linux/jump_label.h line 28

Quoted 8 lines
include/linux/jump_label.h +1 -1
@@ -22,7 +22,7 @@
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
  * static_key_likely()
- * statick_key_unlikely()
+ * static_key_unlikely()
  *
  * Jump labels provide an interface to generate dynamic branches using
  * self-modifying code. Assuming toolchain and architecture support, if we

Thanks. I actually messed this up further. That's supposed to be, 'static_branch_likely()', and 'static_branch_unlikely()'. So:

s/static_key_likely()/static_branch_likely()

and

s/static_key_unlikely()/static_branch_unlikely()

The rest of the doc appears to have it correctly. There are a few more typos in there as well:

1)

s/addtion/addition

2)

"
The inc()/dec() interface is meant to be used exclusively from the inc()/dec() for a given key.
"

Was supposed to read:

"
The inc()/dec() interface is meant to be used exclusively from the enable()/disable() interface for a given key.
"

However, I think we should just delete this sentence. As the API inherently doesn't prevent this. The user just may need to be aware to properly serialize operations.

Thanks,

-Jason

#4 lore raw
Quoted 63 lines · Jason Baron
Quoted 28 lines · Jonathan Corbet

412758cb2670 (jump label, locking/static_keys: Update docs) introduced a typo that might as well get fixed.

---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +1 -1
index f4cb0b2..ec91158 100644
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()
 
 0) Abstract
 
include/linux/jump_label.h +0 -0
index 7f653e8..0684bd3 100644

include/linux/jump_label.h line 28

Quoted 8 lines
include/linux/jump_label.h +1 -1
@@ -22,7 +22,7 @@
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
  * static_key_likely()
- * statick_key_unlikely()
+ * static_key_unlikely()
  *
  * Jump labels provide an interface to generate dynamic branches using
  * self-modifying code. Assuming toolchain and architecture support, if we

Thanks. I actually messed this up further. That's supposed to be, 'static_branch_likely()', and 'static_branch_unlikely()'. So:

s/static_key_likely()/static_branch_likely()

and

s/static_key_unlikely()/static_branch_unlikely()

The rest of the doc appears to have it correctly. There are a few more typos in there as well:

1)

s/addtion/addition

2)

"
The inc()/dec() interface is meant to be used exclusively from the inc()/dec() for a given key.
"

Was supposed to read:

Quoted 8 lines

"
The inc()/dec() interface is meant to be used exclusively from the enable()/disable() interface for a given key.
"

However, I think we should just delete this sentence. As the API inherently doesn't prevent this. The user just may need to be aware to properly serialize operations.

Would be nice to turn this into a patch!

Thanks,

Ingo

#5 lore raw
In reply to Jason Baron
Quoted 43 lines · On Tue, 08 Sep 2015 12:05:04 -0400 Jason Baron <[email protected]> wrote:
Quoted 28 lines · Jonathan Corbet

412758cb2670 (jump label, locking/static_keys: Update docs) introduced a typo that might as well get fixed.

---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/static-keys.txt +1 -1
index f4cb0b2..ec91158 100644
@@ -16,7 +16,7 @@ The updated API replacements are:
 DEFINE_STATIC_KEY_TRUE(key);
 DEFINE_STATIC_KEY_FALSE(key);
 static_key_likely()
-statick_key_unlikely()
+static_key_unlikely()
 
 0) Abstract
 
include/linux/jump_label.h +0 -0
index 7f653e8..0684bd3 100644

include/linux/jump_label.h line 28

Quoted 8 lines
include/linux/jump_label.h +1 -1
@@ -22,7 +22,7 @@
  * DEFINE_STATIC_KEY_TRUE(key);
  * DEFINE_STATIC_KEY_FALSE(key);
  * static_key_likely()
- * statick_key_unlikely()
+ * static_key_unlikely()
  *
  * Jump labels provide an interface to generate dynamic branches using
  * self-modifying code. Assuming toolchain and architecture support, if we

Thanks. I actually messed this up further. That's supposed to be, 'static_branch_likely()', and 'static_branch_unlikely()'. So:

Quoted 6 lines

s/static_key_likely()/static_branch_likely()

and

s/static_key_unlikely()/static_branch_unlikely()

I sent a patch to fix that part on August 25:
https://lkml.org/lkml/2015/8/25/288

Did I send it to the wrong person?

author maintainer
#6 lore raw
Quoted 4 lines · On Wed, 16 Sep 2015 21:04:31 -0400 Chuck Ebbert <[email protected]> wrote:

I sent a patch to fix that part on August 25:
https://lkml.org/lkml/2015/8/25/288

Did I send it to the wrong person?

Well, at that date, I think that the relevant text was only to be found in the tip tree. So the logical targets for the patch would have been the tip maintainers and/or Jason, whose text you were modifying. You copied neither, so it's not entirely surprising that the patch fell on the floor.

Apologies, anyway, I certainly didn't mean to step in on something you'd already fixed. I'd suggest resubmitting the remaining parts of that patch when you get a chance.

jon