[PATCH] locking/static_keys: fix a silly typo

[PATCH] locking/static_keys: fix a silly typo

[Jonathan Corbet]

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

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
index f4cb0b2..ec91158 100644
--- a/Documentation/static-keys.txt
+++ b/Documentation/static-keys.txt
@@ -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
 
diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
index 7f653e8..0684bd3 100644
--- a/include/linux/jump_label.h
+++ b/include/linux/jump_label.h
@@ -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
-- 
2.5.1

Re: [PATCH] locking/static_keys: fix a silly typo

[Ingo Molnar]

* Jonathan Corbet <corbet@lwn.net> wrote:

> 412758cb2670 (jump label, locking/static_keys: Update docs) introduced a
> typo that might as well get fixed.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  Documentation/static-keys.txt | 2 +-
>  include/linux/jump_label.h    | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
> index f4cb0b2..ec91158 100644
> --- a/Documentation/static-keys.txt
> +++ b/Documentation/static-keys.txt
> @@ -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

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

[tip-bot for Jonathan Corbet]

Commit-ID:  edcd591c77a48da753456f92daf8bb50fe9bac93
Gitweb:     http://git.kernel.org/tip/edcd591c77a48da753456f92daf8bb50fe9bac93
Author:     Jonathan Corbet <corbet@lwn.net>
AuthorDate: Mon, 7 Sep 2015 13:18:03 -0600
Committer:  Ingo Molnar <mingo@kernel.org>
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.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jason Baron <jbaron@akamai.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Link: http://lkml.kernel.org/r/20150907131803.54c027e1@lwn.net
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
 Documentation/static-keys.txt | 2 +-
 include/linux/jump_label.h    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
index f4cb0b2..ec91158 100644
--- a/Documentation/static-keys.txt
+++ b/Documentation/static-keys.txt
@@ -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
 
diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
index 7f653e8..0684bd3 100644
--- a/include/linux/jump_label.h
+++ b/include/linux/jump_label.h
@@ -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

Re: [PATCH] locking/static_keys: fix a silly typo

[Jason Baron]

On 09/07/2015 03:18 PM, Jonathan Corbet wrote:
> 412758cb2670 (jump label, locking/static_keys: Update docs) introduced a
> typo that might as well get fixed.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  Documentation/static-keys.txt | 2 +-
>  include/linux/jump_label.h    | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
> index f4cb0b2..ec91158 100644
> --- a/Documentation/static-keys.txt
> +++ b/Documentation/static-keys.txt
> @@ -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
>  
> diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
> index 7f653e8..0684bd3 100644
> --- a/include/linux/jump_label.h
> +++ b/include/linux/jump_label.h
> @@ -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

Re: [PATCH] locking/static_keys: fix a silly typo

[Ingo Molnar]

* Jason Baron <jbaron@akamai.com> wrote:

> On 09/07/2015 03:18 PM, Jonathan Corbet wrote:
> > 412758cb2670 (jump label, locking/static_keys: Update docs) introduced a
> > typo that might as well get fixed.
> > 
> > Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> > ---
> >  Documentation/static-keys.txt | 2 +-
> >  include/linux/jump_label.h    | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
> > index f4cb0b2..ec91158 100644
> > --- a/Documentation/static-keys.txt
> > +++ b/Documentation/static-keys.txt
> > @@ -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
> >  
> > diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
> > index 7f653e8..0684bd3 100644
> > --- a/include/linux/jump_label.h
> > +++ b/include/linux/jump_label.h
> > @@ -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.

Would be nice to turn this into a patch!

Thanks,

	Ingo

Re: [PATCH] locking/static_keys: fix a silly typo

[Chuck Ebbert]

On Tue, 08 Sep 2015 12:05:04 -0400
Jason Baron <jbaron@akamai.com> wrote:

> 
> 
> On 09/07/2015 03:18 PM, Jonathan Corbet wrote:
> > 412758cb2670 (jump label, locking/static_keys: Update docs) introduced a
> > typo that might as well get fixed.
> > 
> > Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> > ---
> >  Documentation/static-keys.txt | 2 +-
> >  include/linux/jump_label.h    | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.txt
> > index f4cb0b2..ec91158 100644
> > --- a/Documentation/static-keys.txt
> > +++ b/Documentation/static-keys.txt
> > @@ -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
> >  
> > diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
> > index 7f653e8..0684bd3 100644
> > --- a/include/linux/jump_label.h
> > +++ b/include/linux/jump_label.h
> > @@ -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()
> 

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?

Re: [PATCH] locking/static_keys: fix a silly typo

[Jonathan Corbet]

On Wed, 16 Sep 2015 21:04:31 -0400
Chuck Ebbert <cebbert.lkml@gmail.com> 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