Received: by 2002:a25:4158:0:0:0:0:0 with SMTP id o85csp5224875yba; Mon, 13 May 2019 07:25:42 -0700 (PDT) X-Google-Smtp-Source: APXvYqyEa0D5d8YA+lztjjVk5VsQEwVdtdPSdHV0XRWdDZzzaW1WK/BgeYo0FhcK94lfPNy2QMY9 X-Received: by 2002:a17:902:8305:: with SMTP id bd5mr7036834plb.339.1557757542752; Mon, 13 May 2019 07:25:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1557757542; cv=none; d=google.com; s=arc-20160816; b=boZJS7RxGHPc+a3h6YRcwekHqWTVsSWcVmRDgzpDA5yCByBZ1BQI+Hpu+y13eUl43i HK0QU6Scda653D/VXPSqYxJJDXO69LE5PzsC6Jfv7Noh4lsmYbke1DPTTBnpg9Vcu0DG ZHtMOoyj7z7vUIVylK7WMDinM7mrsM/V5nzaFouHwLt3k6k8jg0eIj0yrrZrNr7b0Eso jWiZUO9VUUeXDlq6U/d7ZCsGMs/5bWfyMBDS4JAnGOMdAbQzCxcRhbmsfDBDij0NALM1 unjDKONsd+qIXviYDvku2FSXea7Bpxz9Z0FPgHyzjTI/8QXUZXB7IRXUd3tu3YFaKDXy EQEg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=NlhYJ90ofQ2Zr9Y+SOGQmX2unDhBRzK1V3FREqlRH+I=; b=DAk3oY0SSJBJZCmcoFgGybOGPNurK8YEouaMgR4CLTSCY3TnJL/WgpspzIHM0lsnY2 mmS8jraN1foDhoGbjNDg+ptoUuRrmuGS9Ie/UFx1odKK0A1t2Nhbh35LZCkLs/kR2rrg /YN0Yx5KVQQg6mh4FAVvZ3M/J7WGwO0fSYt2kPCY6DDUusHa1nN4WZgpF64TLW6+vwQY YgHhwZww9fIoch0S4ccLxP+UEYRrIXoqujmDUDdzbRA57SrrihZmxLXt88nCyrT7CYlc itjKjrf63nF7wfPCgBAuN2exivRcxau7u2ZI3clHR53EdY/TlWsD0MDm0ZZty+axb8qi Y+iA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=AKMtRnkl; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id u36si16758496pgn.506.2019.05.13.07.25.26; Mon, 13 May 2019 07:25:42 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=AKMtRnkl; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730199AbfEMOUS (ORCPT + 99 others); Mon, 13 May 2019 10:20:18 -0400 Received: from mail-pl1-f195.google.com ([209.85.214.195]:34673 "EHLO mail-pl1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730152AbfEMOUS (ORCPT ); Mon, 13 May 2019 10:20:18 -0400 Received: by mail-pl1-f195.google.com with SMTP id w7so6584883plz.1; Mon, 13 May 2019 07:20:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=NlhYJ90ofQ2Zr9Y+SOGQmX2unDhBRzK1V3FREqlRH+I=; b=AKMtRnklH+seg+WEw3Qyba/aDLReD06wyiitmqq4ZD72fRzwB9b0cyu/YszACKxEPb uZGiAcKFqzsrKiaBoZdiozfUVwhQbIATQ/zuSwZ58m+qPgyKZCW5gVbvZXI2AnD8SKly n9n7ujMAkzGD7x2eM2bxYsWMTra3iTj4ZsIaEEo+LRGxc/6dnW9cqI2k8PmVt1Nc2qVY nxPyfWHo58yxv7cYUfxneIKyFRCRhDxqVCfyD33WG+Xtkc830urXfXEhUgGnYzNFnHM4 pOXKu7x5Vho6c+WHsR1WEviXiYit7VEiefjoeOPnnJiDNpBHe2JXW/L9kZpgCykQ4nQj Cj+w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=NlhYJ90ofQ2Zr9Y+SOGQmX2unDhBRzK1V3FREqlRH+I=; b=piDFPkula0ZYJ/w7Vz5yWMlJU+Ir4k6acRnDv0/a8hg/OZqjMx897Sr1Y/Ci9oh688 cPSa+LXxcKe5NA7mNQXu76PM+YlnlXX6Ktbd6e3dixTAYvl/Bl2T4ad5Aqa/LeajVSm+ cwHwvqTkoSpsXibmIyx01ibjMuVs4QvsShVvfhchVS6QNho+COqfjjhabiBqSOJVdfD1 HQW/RSvytqe9OZgiLAMOdX37EHQuVIR3fkZ8DfBqcFjGA1TFT79YveUcee6DhJARxKnj uWhC9UK0OHgrkwB08hp/1bM5+R6YOtZ6+kRDATUG71kt8mUH4SNbxyPhSbxD5JtSiJMQ h9JQ== X-Gm-Message-State: APjAAAXkvVwNVlZfyMJK3nrwVZJx6V2xCFrNmDfhrfDZUPiw5mIJFrAE X/hiizvg3KpVkUT6sgMz9+sNAGC+ X-Received: by 2002:a17:902:b412:: with SMTP id x18mr31197262plr.304.1557757216857; Mon, 13 May 2019 07:20:16 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id x30sm15382513pgl.76.2019.05.13.07.20.12 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Mon, 13 May 2019 07:20:16 -0700 (PDT) From: Changbin Du To: bhelgaas@google.com, corbet@lwn.net Cc: linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, mchehab+samsung@kernel.org, Changbin Du Subject: [PATCH v5 00/12] Include linux PCI docs into Sphinx TOC tree Date: Mon, 13 May 2019 22:19:48 +0800 Message-Id: <20190513142000.3524-1-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi all, The kernel now uses Sphinx to generate intelligent and beautiful documentation from reStructuredText files. I converted most of the Linux PCI docs to rst format in this serias. For you to preview, please visit below url: http://www.bytemem.com:8080/kernel-doc/PCI/index.html Thank you! v2: trivial style update. v3: update titles. (Bjorn Helgaas) v4: fix comments from Mauro Carvalho Chehab v5: update MAINTAINERS (Joe Perches) Changbin Du (12): Documentation: add Linux PCI to Sphinx TOC tree Documentation: PCI: convert pci.txt to reST Documentation: PCI: convert PCIEBUS-HOWTO.txt to reST Documentation: PCI: convert pci-iov-howto.txt to reST Documentation: PCI: convert MSI-HOWTO.txt to reST Documentation: PCI: convert acpi-info.txt to reST Documentation: PCI: convert pci-error-recovery.txt to reST Documentation: PCI: convert pcieaer-howto.txt to reST Documentation: PCI: convert endpoint/pci-endpoint.txt to reST Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt to reST Documentation: PCI: convert endpoint/pci-test-function.txt to reST Documentation: PCI: convert endpoint/pci-test-howto.txt to reST .../PCI/{acpi-info.txt => acpi-info.rst} | 15 +- Documentation/PCI/endpoint/index.rst | 13 + ...-endpoint-cfs.txt => pci-endpoint-cfs.rst} | 99 ++--- .../{pci-endpoint.txt => pci-endpoint.rst} | 96 +++-- ...est-function.txt => pci-test-function.rst} | 34 +- ...{pci-test-howto.txt => pci-test-howto.rst} | 81 ++-- Documentation/PCI/index.rst | 18 + .../PCI/{MSI-HOWTO.txt => msi-howto.rst} | 85 +++-- ...or-recovery.txt => pci-error-recovery.rst} | 287 +++++++------- .../{pci-iov-howto.txt => pci-iov-howto.rst} | 161 ++++---- Documentation/PCI/{pci.txt => pci.rst} | 356 ++++++++---------- .../{pcieaer-howto.txt => pcieaer-howto.rst} | 156 +++++--- .../{PCIEBUS-HOWTO.txt => picebus-howto.rst} | 140 ++++--- Documentation/index.rst | 1 + MAINTAINERS | 4 +- include/linux/mod_devicetable.h | 19 + include/linux/pci.h | 37 ++ 17 files changed, 913 insertions(+), 689 deletions(-) rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (96%) create mode 100644 Documentation/PCI/endpoint/index.rst rename Documentation/PCI/endpoint/{pci-endpoint-cfs.txt => pci-endpoint-cfs.rst} (64%) rename Documentation/PCI/endpoint/{pci-endpoint.txt => pci-endpoint.rst} (82%) rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (84%) rename Documentation/PCI/endpoint/{pci-test-howto.txt => pci-test-howto.rst} (78%) create mode 100644 Documentation/PCI/index.rst rename Documentation/PCI/{MSI-HOWTO.txt => msi-howto.rst} (88%) rename Documentation/PCI/{pci-error-recovery.txt => pci-error-recovery.rst} (67%) rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%) rename Documentation/PCI/{pci.txt => pci.rst} (68%) rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (72%) rename Documentation/PCI/{PCIEBUS-HOWTO.txt => picebus-howto.rst} (70%) -- 2.20.1