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=-6.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=unavailable 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 EB614C31E4A for ; Thu, 13 Jun 2019 16:59:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id CDF1B20665 for ; Thu, 13 Jun 2019 16:59:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2390069AbfFMQ7M (ORCPT ); Thu, 13 Jun 2019 12:59:12 -0400 Received: from outgoing-stata.csail.mit.edu ([128.30.2.210]:53158 "EHLO outgoing-stata.csail.mit.edu" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729848AbfFMAeY (ORCPT ); Wed, 12 Jun 2019 20:34:24 -0400 X-Greylist: delayed 493 seconds by postgrey-1.27 at vger.kernel.org; Wed, 12 Jun 2019 20:34:23 EDT Received: from [4.30.142.84] (helo=srivatsab-a01.vmware.com) by outgoing-stata.csail.mit.edu with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1hbDYq-000Xfo-J5; Wed, 12 Jun 2019 20:25:48 -0400 Subject: Re: [PATCH v4 18/28] docs: convert docs to ReST and rename to *.rst To: Mauro Carvalho Chehab , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Sebastian Reichel , "Rafael J. Wysocki" , Viresh Kumar , Len Brown , Pavel Machek , Nishanth Menon , Stephen Boyd , Liam Girdwood , Mark Brown , Mathieu Poirier , Suzuki K Poulose , Harry Wei , Alex Shi , Thomas Gleixner , Ingo Molnar , Borislav Petkov , "H. Peter Anvin" , x86@kernel.org, Jani Nikula , Joonas Lahtinen , Rodrigo Vivi , David Airlie , Daniel Vetter , Bjorn Helgaas , Johannes Berg , "David S. Miller" , linux-pm@vger.kernel.org, linux-arm-kernel@lists.infradead.org, intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, linux-pci@vger.kernel.org, linux-wireless@vger.kernel.org, netdev@vger.kernel.org References: From: "Srivatsa S. Bhat" Message-ID: <7dc94cb4-ebf1-22ab-29c9-fcb2b875a9ac@csail.mit.edu> Date: Wed, 12 Jun 2019 17:25:39 -0700 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:60.0) Gecko/20100101 Thunderbird/60.7.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org On 6/12/19 10:52 AM, Mauro Carvalho Chehab wrote: > Convert the PM documents to ReST, in order to allow them to > build with Sphinx. > > The conversion is actually: > - add blank lines and identation in order to identify paragraphs; > - fix tables markups; > - add some lists markups; > - mark literal blocks; > - adjust title markups. > > At its new index.rst, let's add a :orphan: while this is not linked to > the main index.rst file, in order to avoid build warnings. > > Signed-off-by: Mauro Carvalho Chehab > Acked-by: Bjorn Helgaas > Acked-by: Mark Brown > --- [...] > diff --git a/Documentation/power/suspend-and-cpuhotplug.txt b/Documentation/power/suspend-and-cpuhotplug.rst > similarity index 90% > rename from Documentation/power/suspend-and-cpuhotplug.txt > rename to Documentation/power/suspend-and-cpuhotplug.rst > index a8751b8df10e..9df664f5423a 100644 > --- a/Documentation/power/suspend-and-cpuhotplug.txt > +++ b/Documentation/power/suspend-and-cpuhotplug.rst > @@ -1,10 +1,15 @@ > +==================================================================== > Interaction of Suspend code (S3) with the CPU hotplug infrastructure > +==================================================================== > > - (C) 2011 - 2014 Srivatsa S. Bhat > +(C) 2011 - 2014 Srivatsa S. Bhat > > > -I. How does the regular CPU hotplug code differ from how the Suspend-to-RAM > - infrastructure uses it internally? And where do they share common code? > +I. Differences between CPU hotplug and Suspend-to-RAM > +====================================================== > + > +How does the regular CPU hotplug code differ from how the Suspend-to-RAM > +infrastructure uses it internally? And where do they share common code? > > Well, a picture is worth a thousand words... So ASCII art follows :-) > [...] > @@ -101,7 +108,7 @@ execution during resume): > > It is to be noted here that the system_transition_mutex lock is acquired at the very > beginning, when we are just starting out to suspend, and then released only > -after the entire cycle is complete (i.e., suspend + resume). > +after the entire cycle is complete (i.e., suspend + resume):: > I think that should be a period, not a colon, because it is clarifying the text above it (as opposed to referring to the example below it). Other than that, for suspend-and-cpuhotplug.txt: Acked-by: Srivatsa S. Bhat (VMware) Regards, Srivatsa VMware Photon OS