From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1751469AbbIMIPl (ORCPT <rfc822;w@1wt.eu>);
	Sun, 13 Sep 2015 04:15:41 -0400
Received: from mail-wi0-f181.google.com ([209.85.212.181]:33372 "EHLO
	mail-wi0-f181.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
	with ESMTP id S1751139AbbIMIPi (ORCPT
	<rfc822;linux-kernel@vger.kernel.org>);
	Sun, 13 Sep 2015 04:15:38 -0400
Date: Sun, 13 Sep 2015 10:15:33 +0200
From: Ingo Molnar <mingo@kernel.org>
To: Jason Baron <jbaron@akamai.com>
Cc: Jonathan Corbet <corbet@lwn.net>, Ingo Molnar <mingo@elte.hu>,
        LKML <linux-kernel@vger.kernel.org>,
        Peter Zijlstra <a.p.zijlstra@chello.nl>,
        Thomas Gleixner <tglx@linutronix.de>
Subject: Re: [PATCH] locking/static_keys: fix a silly typo
Message-ID: <20150913081532.GA8488@gmail.com>
References: <20150907131803.54c027e1@lwn.net>
 <55EF0730.3080906@akamai.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <55EF0730.3080906@akamai.com>
User-Agent: Mutt/1.5.23 (2014-03-12)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


* 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