From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.6 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B3283C43331 for ; Thu, 26 Mar 2020 02:40:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 78A622073E for ; Thu, 26 Mar 2020 02:40:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1585190440; bh=B/0A+EakHUoxJZZH8Zsz0E0Jrwx9AZ5KMhmmm4tWgAU=; h=Date:From:To:Cc:Subject:Reply-To:References:In-Reply-To:List-ID: From; b=tEwRA3AZeZ6M9mxKxM9zUbC3sz0g3NqG79VUtUfuqSehx59JXWZKQ9pSLZNaMsFK5 91TIPOmf5xpzAMvLyRSfwAfrbjr7WlSOCXnBtoqdBWao5c28Syyawsvjax5PM/ozAt tyYIbPoo5xM1/5ui/XfgAtrUl7l6wMr82/2Wh5mA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727600AbgCZCkj (ORCPT ); Wed, 25 Mar 2020 22:40:39 -0400 Received: from mail.kernel.org ([198.145.29.99]:59496 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727560AbgCZCkj (ORCPT ); Wed, 25 Mar 2020 22:40:39 -0400 Received: from paulmck-ThinkPad-P72.home (50-39-105-78.bvtn.or.frontiernet.net [50.39.105.78]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id F23B020714; Thu, 26 Mar 2020 02:40:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1585190438; bh=B/0A+EakHUoxJZZH8Zsz0E0Jrwx9AZ5KMhmmm4tWgAU=; h=Date:From:To:Cc:Subject:Reply-To:References:In-Reply-To:From; b=hlvpwsdFfUlivcRX+rgOky3Qzz9W6+h3DS6rDIiFCMTcOVT/UZK7XAVPOw5xlfZmc U4gWvMk+HY610Ebp67p0IXeEOlLqhqArE8W38Bn1Pstxz2UMd+wQaxLwVqwPtOGuCa LHixNahpVcBZT1S+4QWNrSt9INUA9VsBP8hxz+k8= Received: by paulmck-ThinkPad-P72.home (Postfix, from userid 1000) id C134335226B0; Wed, 25 Mar 2020 19:40:37 -0700 (PDT) Date: Wed, 25 Mar 2020 19:40:37 -0700 From: "Paul E. McKenney" To: Randy Dunlap Cc: Thomas Gleixner , LKML , Peter Zijlstra , Ingo Molnar , Sebastian Siewior , Linus Torvalds , Joel Fernandes , Oleg Nesterov , Davidlohr Bueso , Jonathan Corbet , Logan Gunthorpe , Bjorn Helgaas , Kurt Schwemmer , linux-pci@vger.kernel.org, Greg Kroah-Hartman , Felipe Balbi , linux-usb@vger.kernel.org, Kalle Valo , "David S. Miller" , linux-wireless@vger.kernel.org, netdev@vger.kernel.org, Darren Hart , Andy Shevchenko , platform-driver-x86@vger.kernel.org, Zhang Rui , "Rafael J. Wysocki" , linux-pm@vger.kernel.org, Len Brown , linux-acpi@vger.kernel.org, kbuild test robot , Nick Hu , Greentime Hu , Vincent Chen , Guo Ren , linux-csky@vger.kernel.org, Brian Cain , linux-hexagon@vger.kernel.org, Tony Luck , Fenghua Yu , linux-ia64@vger.kernel.org, Michal Simek , Michael Ellerman , Arnd Bergmann , Geoff Levand , linuxppc-dev@lists.ozlabs.org, Davidlohr Bueso Subject: Re: [PATCH v2] Documentation/locking/locktypes: minor copy editor fixes Message-ID: <20200326024037.GJ19865@paulmck-ThinkPad-P72> Reply-To: paulmck@kernel.org References: <20200323025501.GE3199@paulmck-ThinkPad-P72> <87r1xhz6qp.fsf@nanos.tec.linutronix.de> <20200325002811.GO19865@paulmck-ThinkPad-P72> <87wo78y5yy.fsf@nanos.tec.linutronix.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.9.4 (2018-02-28) Sender: linux-acpi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org On Wed, Mar 25, 2020 at 09:58:14AM -0700, Randy Dunlap wrote: > From: Randy Dunlap > > Minor editorial fixes: > - add some hyphens in multi-word adjectives > - add some periods for consistency > - add "'" for possessive CPU's > - capitalize IRQ when it's an acronym and not part of a function name > > Signed-off-by: Randy Dunlap > Cc: Paul McKenney > Cc: Thomas Gleixner > Cc: Sebastian Siewior > Cc: Joel Fernandes > Cc: Ingo Molnar > Cc: Peter Zijlstra Some nits below, but with or without those suggested changes: Reviewed-by: Paul E. McKenney > --- > Documentation/locking/locktypes.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > --- linux-next-20200325.orig/Documentation/locking/locktypes.rst > +++ linux-next-20200325/Documentation/locking/locktypes.rst > @@ -84,7 +84,7 @@ rtmutex > > RT-mutexes are mutexes with support for priority inheritance (PI). > > -PI has limitations on non PREEMPT_RT enabled kernels due to preemption and > +PI has limitations on non-PREEMPT_RT-enabled kernels due to preemption and Or just drop the " enabled". > interrupt disabled sections. > > PI clearly cannot preempt preemption-disabled or interrupt-disabled > @@ -150,7 +150,7 @@ kernel configuration including PREEMPT_R > > raw_spinlock_t is a strict spinning lock implementation in all kernels, > including PREEMPT_RT kernels. Use raw_spinlock_t only in real critical > -core code, low level interrupt handling and places where disabling > +core code, low-level interrupt handling and places where disabling > preemption or interrupts is required, for example, to safely access > hardware state. raw_spinlock_t can sometimes also be used when the > critical section is tiny, thus avoiding RT-mutex overhead. > @@ -160,20 +160,20 @@ spinlock_t > > The semantics of spinlock_t change with the state of PREEMPT_RT. > > -On a non PREEMPT_RT enabled kernel spinlock_t is mapped to raw_spinlock_t > +On a non-PREEMPT_RT-enabled kernel spinlock_t is mapped to raw_spinlock_t Ditto. > and has exactly the same semantics. > > spinlock_t and PREEMPT_RT > ------------------------- > > -On a PREEMPT_RT enabled kernel spinlock_t is mapped to a separate > +On a PREEMPT_RT-enabled kernel spinlock_t is mapped to a separate And here as well. > implementation based on rt_mutex which changes the semantics: > > - - Preemption is not disabled > + - Preemption is not disabled. > > - The hard interrupt related suffixes for spin_lock / spin_unlock > - operations (_irq, _irqsave / _irqrestore) do not affect the CPUs > - interrupt disabled state > + operations (_irq, _irqsave / _irqrestore) do not affect the CPU's > + interrupt disabled state. > > - The soft interrupt related suffix (_bh()) still disables softirq > handlers. > @@ -279,7 +279,7 @@ fully preemptible context. Instead, use > spin_lock_irqsave() and their unlock counterparts. In cases where the > interrupt disabling and locking must remain separate, PREEMPT_RT offers a > local_lock mechanism. Acquiring the local_lock pins the task to a CPU, > -allowing things like per-CPU irq-disabled locks to be acquired. However, > +allowing things like per-CPU IRQ-disabled locks to be acquired. However, Quite a bit of text in the kernel uses "irq", lower case. Another option is to spell out "interrupt". > this approach should be used only where absolutely necessary. > > >