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=-1.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,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 4E3BEC43219 for ; Fri, 26 Apr 2019 09:46:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 1CF28206BA for ; Fri, 26 Apr 2019 09:46:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1556272002; bh=9RT8xA5jMBv6EzT8N9JRPoEns1coQhC9bYDVc6PmTws=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=AwolLZBD7dimBnWvkx4xw670MdVlpBKYK8LFfo6RmX44H1oc/putJiB9hpzvJiPcO oX93LcvsPbzsP2gR573qOTZF1XufCXGs2YVIx2zuJ5KMcMfAESTNcsJPkubUrskPiO EX3wOiZz9j8URDB5Kig7zBZS5HlDCsQWAyQQVUuw= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726610AbfDZJqf (ORCPT ); Fri, 26 Apr 2019 05:46:35 -0400 Received: from casper.infradead.org ([85.118.1.10]:52042 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725985AbfDZJqf (ORCPT ); Fri, 26 Apr 2019 05:46:35 -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=gTBjYHF7PdfcMS747oVD2PM5dGAfiuGzrLBbmiynnAI=; b=ThiRHSVnK8igKQlUt70ItUpgfn ahvUpV2Rj5VYX6v2qdgqkJ5YDlrjlEHjCiqciVId/LoW/vvbKtqqhjBZvImCJFrk4tTc96+SgQTMt 3OwLruS8ajlGs/wQ20K30ls643aeeOVpb/B7MjXylL0emp1dw6nykZEPhyzyfDfgrbPNaH7y3BxV8 0/Pf9E/MtLsN+dZ02jvg38Neh4bT8CtGsUuBDGhhjAjqMii4uRKfUZed6iZ/INQKwoT8UUu5T/2j8 o0WOHq5yMZ0fJgkLpfKIpMcsztztvKqpYFW56Aq/Y4OzodfEabMJl4Dq9mXtvOf21R/5AYdWX7Hzf niiIxfrA==; Received: from [179.95.39.209] (helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJxQz-000573-Hl; Fri, 26 Apr 2019 09:46:22 +0000 Date: Fri, 26 Apr 2019 06:46:09 -0300 From: Mauro Carvalho Chehab To: Mark Brown Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Sebastian Reichel , Bjorn Helgaas , "Rafael J. Wysocki" , Viresh Kumar , Len Brown , Pavel Machek , Nishanth Menon , Stephen Boyd , Liam Girdwood , 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 , Johannes Berg , "David S. Miller" , linux-pm@vger.kernel.org, linux-pci@vger.kernel.org, linux-arm-kernel@lists.infradead.org, intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, linux-wireless@vger.kernel.org, netdev@vger.kernel.org Subject: Re: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst Message-ID: <20190426064609.7f00e013@coco.lan> In-Reply-To: <20190425180758.GC23183@sirena.org.uk> References: <7adf9035ae06ecc6c7e46b51cb677f0a8f61d19a.1555938376.git.mchehab+samsung@kernel.org> <20190425180758.GC23183@sirena.org.uk> 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-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org Hi Mark, Em Thu, 25 Apr 2019 19:07:58 +0100 Mark Brown escreveu: > On Mon, Apr 22, 2019 at 10:27:14AM -0300, Mauro Carvalho Chehab wrote: > > Convert the PM documents to ReST, in order to allow them to > > build with Sphinx. > > This is massively CCed covering a large range of subsystems and is patch > 25 of a 79 patch series so I've no context for what's going on here or > why... There are two goals of this series: 1) to prepare for placing the new *.rst files under Documentation/ into an index file, being part of one of the books. Most of the stuff covered on this series either fit at the system admin guide or at the Kernel API documentation book; 2) to ensure that, if some edition on a file would cause warnings at Sphinx build, someone will notice and submit a followup patch. You can see more details at patch 00/79: https://lore.kernel.org/lkml/20190422115110.26443b44@coco.lan/ In order to do that, this series has one patch per Documentation/* sub-directory. This specific one is for the documents under Documentation/power/ [1]. [1] btw, the title of this specific patch should be, instead: docs: power: convert docs to ReST and rename to *.rst The series is long because I'm trying to cover a significant part of the documentation files. In any case, except if an eventual conflict might rise on some file, this patch is independent from all other files, and should be safe to apply directly via the subsystem git tree. I'm working on a follow-up patch series that should be adding the power/index.rst file into another index file - probably at Documentation/index.rst[1]. As such patch will be adding a lot of other index files, the best would be to merge it via the docs tree, in order to avoid conflicts. [1] such patch will be removing the ":orphan:" meta-tag from it (that basically tells the build system to not produce warnings if the file is not directly or indirectly referenced by the main index file). Thanks, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: Re: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst Date: Fri, 26 Apr 2019 06:46:09 -0300 Message-ID: <20190426064609.7f00e013@coco.lan> References: <7adf9035ae06ecc6c7e46b51cb677f0a8f61d19a.1555938376.git.mchehab+samsung@kernel.org> <20190425180758.GC23183@sirena.org.uk> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20190425180758.GC23183@sirena.org.uk> Sender: linux-kernel-owner@vger.kernel.org To: Mark Brown Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Sebastian Reichel , Bjorn Helgaas , "Rafael J. Wysocki" , Viresh Kumar , Len Brown , Pavel Machek , Nishanth Menon , Stephen Boyd , Liam Girdwood , Mathieu Poirier , Suzuki K Poulose , Harry Wei , Alex Shi , Thomas Gleixner , Ingo Molnar , Borislav Petkov , "H. Peter Anvin" List-Id: linux-pm@vger.kernel.org Hi Mark, Em Thu, 25 Apr 2019 19:07:58 +0100 Mark Brown escreveu: > On Mon, Apr 22, 2019 at 10:27:14AM -0300, Mauro Carvalho Chehab wrote: > > Convert the PM documents to ReST, in order to allow them to > > build with Sphinx. > > This is massively CCed covering a large range of subsystems and is patch > 25 of a 79 patch series so I've no context for what's going on here or > why... There are two goals of this series: 1) to prepare for placing the new *.rst files under Documentation/ into an index file, being part of one of the books. Most of the stuff covered on this series either fit at the system admin guide or at the Kernel API documentation book; 2) to ensure that, if some edition on a file would cause warnings at Sphinx build, someone will notice and submit a followup patch. You can see more details at patch 00/79: https://lore.kernel.org/lkml/20190422115110.26443b44@coco.lan/ In order to do that, this series has one patch per Documentation/* sub-directory. This specific one is for the documents under Documentation/power/ [1]. [1] btw, the title of this specific patch should be, instead: docs: power: convert docs to ReST and rename to *.rst The series is long because I'm trying to cover a significant part of the documentation files. In any case, except if an eventual conflict might rise on some file, this patch is independent from all other files, and should be safe to apply directly via the subsystem git tree. I'm working on a follow-up patch series that should be adding the power/index.rst file into another index file - probably at Documentation/index.rst[1]. As such patch will be adding a lot of other index files, the best would be to merge it via the docs tree, in order to avoid conflicts. [1] such patch will be removing the ":orphan:" meta-tag from it (that basically tells the build system to not produce warnings if the file is not directly or indirectly referenced by the main index file). Thanks, Mauro 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=-1.0 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,SPF_PASS,URIBL_BLOCKED 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 DFF9DC43218 for ; Fri, 26 Apr 2019 09:46:40 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 959182089E for ; Fri, 26 Apr 2019 09:46:40 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="Sy1A3kyF"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="ThiRHSVn" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 959182089E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=axtja2qY6QvFoK/PprIRtg5SVZLbol/6C7iH3yxbkfE=; b=Sy1A3kyFCk1xrG ClRlJwmXwwoUTiCJHynP5JvWyyCMsuGIkeNPHb7DSgFmqditfzCKKfxlvk0nNncMzcqQ5CfyNUhka Nhji2L5f13txyDE8NeLrDAETIz+mpBuQ97Zp6YLeGmSFpZgx1EPWj4Rp3L9xUFco8XfTvk/15nHHI 7nxmwiuDHTGW+YvFxOvJfO9ip+qlpbp9rxGvC4FIWyyb6nOsh73ZtxzZWRJMST+L0g5cl59ik3WuT KwqZ/S8+u4Y2uHnABuWNa92A2PKNpu4TPELkPQYaUC8CuKoa8GC5BeXl1N4d+TBzeF8fNaWqCmDj7 dIwTaZd2rkdH+szviJwg==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJxRC-0006kA-9F; Fri, 26 Apr 2019 09:46:34 +0000 Received: from casper.infradead.org ([2001:8b0:10b:1236::1]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJxRB-0006i4-3C; Fri, 26 Apr 2019 09:46:33 +0000 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=gTBjYHF7PdfcMS747oVD2PM5dGAfiuGzrLBbmiynnAI=; b=ThiRHSVnK8igKQlUt70ItUpgfn ahvUpV2Rj5VYX6v2qdgqkJ5YDlrjlEHjCiqciVId/LoW/vvbKtqqhjBZvImCJFrk4tTc96+SgQTMt 3OwLruS8ajlGs/wQ20K30ls643aeeOVpb/B7MjXylL0emp1dw6nykZEPhyzyfDfgrbPNaH7y3BxV8 0/Pf9E/MtLsN+dZ02jvg38Neh4bT8CtGsUuBDGhhjAjqMii4uRKfUZed6iZ/INQKwoT8UUu5T/2j8 o0WOHq5yMZ0fJgkLpfKIpMcsztztvKqpYFW56Aq/Y4OzodfEabMJl4Dq9mXtvOf21R/5AYdWX7Hzf niiIxfrA==; Received: from [179.95.39.209] (helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJxQz-000573-Hl; Fri, 26 Apr 2019 09:46:22 +0000 Date: Fri, 26 Apr 2019 06:46:09 -0300 From: Mauro Carvalho Chehab To: Mark Brown Subject: Re: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst Message-ID: <20190426064609.7f00e013@coco.lan> In-Reply-To: <20190425180758.GC23183@sirena.org.uk> References: <7adf9035ae06ecc6c7e46b51cb677f0a8f61d19a.1555938376.git.mchehab+samsung@kernel.org> <20190425180758.GC23183@sirena.org.uk> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Nishanth Menon , linux-wireless@vger.kernel.org, Linux Doc Mailing List , David Airlie , Viresh Kumar , Joonas Lahtinen , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org, Harry Wei , Pavel Machek , "H. Peter Anvin" , Alex Shi , Jonathan Corbet , x86@kernel.org, Ingo Molnar , linux-pci@vger.kernel.org, Len Brown , Suzuki K Poulose , intel-gfx@lists.freedesktop.org, Jani Nikula , Mauro Carvalho Chehab , Borislav Petkov , Rodrigo Vivi , Bjorn Helgaas , Thomas Gleixner , linux-arm-kernel@lists.infradead.org, Mathieu Poirier , Stephen Boyd , netdev@vger.kernel.org, linux-pm@vger.kernel.org, "Rafael J. Wysocki" , Liam Girdwood , Daniel Vetter , Sebastian Reichel , Johannes Berg , "David S. Miller" Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org Hi Mark, Em Thu, 25 Apr 2019 19:07:58 +0100 Mark Brown escreveu: > On Mon, Apr 22, 2019 at 10:27:14AM -0300, Mauro Carvalho Chehab wrote: > > Convert the PM documents to ReST, in order to allow them to > > build with Sphinx. > > This is massively CCed covering a large range of subsystems and is patch > 25 of a 79 patch series so I've no context for what's going on here or > why... There are two goals of this series: 1) to prepare for placing the new *.rst files under Documentation/ into an index file, being part of one of the books. Most of the stuff covered on this series either fit at the system admin guide or at the Kernel API documentation book; 2) to ensure that, if some edition on a file would cause warnings at Sphinx build, someone will notice and submit a followup patch. You can see more details at patch 00/79: https://lore.kernel.org/lkml/20190422115110.26443b44@coco.lan/ In order to do that, this series has one patch per Documentation/* sub-directory. This specific one is for the documents under Documentation/power/ [1]. [1] btw, the title of this specific patch should be, instead: docs: power: convert docs to ReST and rename to *.rst The series is long because I'm trying to cover a significant part of the documentation files. In any case, except if an eventual conflict might rise on some file, this patch is independent from all other files, and should be safe to apply directly via the subsystem git tree. I'm working on a follow-up patch series that should be adding the power/index.rst file into another index file - probably at Documentation/index.rst[1]. As such patch will be adding a lot of other index files, the best would be to merge it via the docs tree, in order to avoid conflicts. [1] such patch will be removing the ":orphan:" meta-tag from it (that basically tells the build system to not produce warnings if the file is not directly or indirectly referenced by the main index file). Thanks, Mauro _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel