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=-7.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_PASS 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 68300C10F11 for ; Wed, 24 Apr 2019 18:04:43 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 29F0720652 for ; Wed, 24 Apr 2019 18:04:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1556129083; bh=EDtUZor5aMJF3wM9lw3Z+oHRA5Y9c0u2gD1aMiaw6lY=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=EuKoaHF5WOeTFNstM9wg6QkLVHQAQbZ2xRMZ4giMDO0XtAutWxyqyz/kFpUnPlpVE eq7jE4r3Z8Wrd7yf5q5WH56vmPW8B2gOFhr9sZmWijG5lQhqOFdcBpR5DihDDefawI N28NcKup09LuMEGKOrGNTims2W9su4ahnnT96bO0= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2389799AbfDXSEm (ORCPT ); Wed, 24 Apr 2019 14:04:42 -0400 Received: from casper.infradead.org ([85.118.1.10]:48034 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2389233AbfDXSEk (ORCPT ); Wed, 24 Apr 2019 14:04:40 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To:From:Date:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=QQxjRBbmdgAM9Bh3kBDiayTByaZ8rOIgL5n86+QEto4=; b=eHPgs9VBSJ+I8+KqGmbMTju2lr c0xcIJhkO2M5DD563NVO7255UOmAOc+vpo2IvNPVwyqe69ZqXkx9iioAWr9eJ4b2LMu+rhf8rYyUo mtQXyGjUMNv/lFhjz4jaEpC7/Tp0UkNaMIXXlAM2xteretCYdUOIlYuRI08ZjgbyPhkjYAtk47b7m OA0nNjLt5UlGU5fFoI53mMacP+QpIDgHjTG4uSifigHWhQfA2mF9d0P2n0WuaAsakliiGpFMUgQjo rvB17MoDNgV16L/zRs1kMRB1oFucBzRHljfN9aiZfld7RN8Wcr4XEM55inxhU1IiOVWlqKJ5tLTjt pHQcNoMQ==; Received: from 177.17.136.231.dynamic.adsl.gvt.net.br ([177.17.136.231] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJMG2-0001jj-TS; Wed, 24 Apr 2019 18:04:35 +0000 Date: Wed, 24 Apr 2019 15:04:28 -0300 From: Mauro Carvalho Chehab To: Changbin Du Cc: Jonathan Corbet , Bjorn Helgaas , rjw@rjwysocki.net, linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, tglx@linutronix.de, mingo@redhat.com, x86@kernel.org, fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org, linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org Subject: Re: [PATCH v4 21/63] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST Message-ID: <20190424150428.7eb70014@coco.lan> In-Reply-To: <20190424172232.qtzogm6sweaa4gva@mail.google.com> References: <20190423162932.21428-1-changbin.du@gmail.com> <20190423162932.21428-22-changbin.du@gmail.com> <20190424114844.5de4cfa5@coco.lan> <20190424172232.qtzogm6sweaa4gva@mail.google.com> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Thu, 25 Apr 2019 01:22:34 +0800 Changbin Du escreveu: > On Wed, Apr 24, 2019 at 11:48:44AM -0300, Mauro Carvalho Chehab wrote: > > Em Wed, 24 Apr 2019 00:28:50 +0800 > > Changbin Du escreveu: > > > > > This converts the plain text documentation to reStructuredText format and > > > add it to Sphinx TOC tree. No essential content change. > > > > > > Signed-off-by: Changbin Du > > > --- > > > .../acpi/cppc_sysfs.rst} | 71 ++++++++++--------- > > > Documentation/admin-guide/acpi/index.rst | 1 + > > > 2 files changed, 40 insertions(+), 32 deletions(-) > > > rename Documentation/{acpi/cppc_sysfs.txt => admin-guide/acpi/cppc_sysfs.rst} (51%) > > > > > > diff --git a/Documentation/acpi/cppc_sysfs.txt b/Documentation/admin-guide/acpi/cppc_sysfs.rst > > > similarity index 51% > > > rename from Documentation/acpi/cppc_sysfs.txt > > > rename to Documentation/admin-guide/acpi/cppc_sysfs.rst > > > index f20fb445135d..a4b99afbe331 100644 > > > --- a/Documentation/acpi/cppc_sysfs.txt > > > +++ b/Documentation/admin-guide/acpi/cppc_sysfs.rst > > > @@ -1,5 +1,11 @@ > > > +.. SPDX-License-Identifier: GPL-2.0 > > > > > > - Collaborative Processor Performance Control (CPPC) > > > +================================================== > > > +Collaborative Processor Performance Control (CPPC) > > > +================================================== > > > + > > > +CPPC > > > +==== > > > > > > CPPC defined in the ACPI spec describes a mechanism for the OS to manage the > > > performance of a logical processor on a contigious and abstract performance > > > @@ -10,31 +16,28 @@ For more details on CPPC please refer to the ACPI specification at: > > > > > > http://uefi.org/specifications > > > > > > -Some of the CPPC registers are exposed via sysfs under: > > > - > > > -/sys/devices/system/cpu/cpuX/acpi_cppc/ > > > - > > > > > > > -for each cpu X > > > > Hmm... removed by mistake? > > > I comfirmed that no content removed. At this patch, it looks that you removed the line: "for each cpu X" (or am I reading it wrong?) > > > > +Some of the CPPC registers are exposed via sysfs under:: > > > > > > --------------------------------------------------------------------------------- > > > + /sys/devices/system/cpu/cpuX/acpi_cppc/ > > > > Did you parse this with Sphinx? It doesn't sound a valid ReST construction > > to my eyes, as: > > > > 1) I've seen some versions of Sphinx to abort with severe errors when > > there's no blank line after the horizontal bar markup; > > > > 2) It will very likely ignore the "::" (I didn't test it myself), as you're > > not indenting the horizontal bar. End of indentation will mean the end > > of an (empty) literal block. > > > > So, I would stick with: > > > > > > Some of the CPPC registers are exposed via sysfs under: > > > > /sys/devices/system/cpu/cpuX/acpi_cppc/ > > > > --------------------------------------------------------------------------------- > > > > for each cpu X:: > > > > > > or: > > > > Some of the CPPC registers are exposed via sysfs under: > > > > /sys/devices/system/cpu/cpuX/acpi_cppc/ > > > > for each cpu X > > > > -------------------------------------------------------------------------------- > > > > :: > > > > (with is closer to the original author's intent) > > > > Same applies to the other similar changes on this document. > > > I didn't seen any warning here and the generated html is good. So I think it is > ok. Basically, what you're doing is: :: foo literal-block bar (where "foo" is the horizontal bar markup) I would avoid such pattern for two reasons: 1) it sounds a violation of ReST syntax to format an in indented paragraph some non-blank lines after a non-indented line. As such, I won't doubt that different versions of Sphinx would handle it differently. I'm even tempted to open a BZ to Sphinx in order for them to provide a fix for that, if the latest version of Sphinx accepts such crazy markup. 2) It is very confusing for any human reading it. Thanks, Mauro