Received: by 2002:a25:4158:0:0:0:0:0 with SMTP id o85csp3994293yba; Tue, 9 Apr 2019 08:57:39 -0700 (PDT) X-Google-Smtp-Source: APXvYqyopol01aNI5bkOgOQeIhaJMxhfWUtCjrIxxJQTiGOJOl+J2YDyRsGB9YvDcF86kxMC1tTv X-Received: by 2002:a63:fc5a:: with SMTP id r26mr33738809pgk.97.1554825459692; Tue, 09 Apr 2019 08:57:39 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1554825459; cv=none; d=google.com; s=arc-20160816; b=FRDKzqz8GMsJw3GFq2/fdY0EsLJbpeSwBe7+Itq+tszIsVslRpw+bG9fyZXG3FS9Td i/v0uK+dpuuAj4SZOSwFRz0xWboL8Vei2FIE5uhgFIg8cZ5GwbQxxaKanhW4+TC2VzHc 4m5k0UpM7gvZ9D+gp+/zifXGu6HgXkEF86R25THkZkYaGjEPE8CxyhAKxBXcJnqn7Bk8 eM9XAyqP3Z2GOXWj2aMO5Qv0zr0tmkkqq8sQ5ADwFmyJHYjdxOL7sLxIc677wIbGBOP3 o3bOb9QbLmr1sJ2St+afY3eM6lFd/EUzvLLHHhzNzCeH8PHVbF6t4unlJnWlh6GPkVRV BOAw== 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=3NArL0xgn+bI/z7O7fvH+UNWE/Wsc+R2ppo10VSmfkY=; b=FpKIs2SXPhC8TaqTueOhhLxe0KC79wJL+vc7gPm4ReGThQrcwJi8kei9RN6QjZHow3 JpiGhzDnoZ0PXjOsOxWYJs5Rwztd36o7oB4TElI7mT3aM07jaIFzSUAolnwo5EKWBayB wx45fI7exJWj+3DvJdW/fllDieeFXTRBljrq8Y28+b2ZNyatvtmRMtTSNS+1uzLYT/yw YqI9TPegZH/x9WPc8RjsgbUHw3+F8eSF3DM9ZutMOPBCQTN3l0+Cf+yrKNGKmp40dqNh Fpb06LrCDFzqrIBEZmL7TPEWebPW4QQOIeV1i6LqBLFYdr7kF44J3nt2k62WdF+JIi2N g2Lw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=a75qcMrQ; 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 i11si29793792pgj.46.2019.04.09.08.57.23; Tue, 09 Apr 2019 08:57:39 -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=a75qcMrQ; 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 S1726714AbfDIP4i (ORCPT + 99 others); Tue, 9 Apr 2019 11:56:38 -0400 Received: from mail-pg1-f196.google.com ([209.85.215.196]:45967 "EHLO mail-pg1-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726446AbfDIP4i (ORCPT ); Tue, 9 Apr 2019 11:56:38 -0400 Received: by mail-pg1-f196.google.com with SMTP id y3so9522914pgk.12; Tue, 09 Apr 2019 08:56:38 -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=3NArL0xgn+bI/z7O7fvH+UNWE/Wsc+R2ppo10VSmfkY=; b=a75qcMrQNdjNaqS/dkIGlUKP2r0WfpetLqBzkQ2FGrNL9kew0VikeR051l7kz4v16H wfEQqznm6DKEUfs1ByIiYrG775wVQu3rucRjWJE1jJqkHhcLl30scpmtl3oWOOGoNQLU 6j0KnAQAYfNSyIXgO+hVIMIz6/AyZN5dv4hP78QMHXvoix4aY5/FaIuIG6sG1TMratqg 3Xr5I841b0I1E9C6HchQj136pKksQQm3dJv9IwZkrkq7ILtM2jHOWxEdLKGEWy1xJZlt 9PwHDYma0xgy0fEn/DkfZRqYB1aJdWSnoKNUgV/G9iCS7J7rqpMmoPWM6tsv2QHag/5w OFbg== 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=3NArL0xgn+bI/z7O7fvH+UNWE/Wsc+R2ppo10VSmfkY=; b=BvMon7atCTPgQ8vULJJWL2S1w/je14LVaslk0hCVlGNJqCUCxeOCkidQ6ZV8licL8U SIUeZL4t13CVG0L8PqxhEeXxpyQeVoRMssCI/BE2YU0Qx+V4eD1d6mfnpCODPN270XI1 fq5vr4w/FFxC7jZ/fw5swcuPjsu/9R3JdoLup9igB5axIGGMD7V8D+meEBPND8uuQAg+ fqpSGSElDaamYXUAaUu1nVAiu1+8gkwypymAEzoT0+IN2ubLyYjOrw8UNq/Cis/xCCes 4BC7ni8lu0RLyAaXonT6jSTZT/DEACllFehAWYrfyUsDgl45tC5PxAyJlWH/vn1bPlmX 3niQ== X-Gm-Message-State: APjAAAVFR6T4GZo6gFnJzZU2WW9vt/MpRFfZl7YS8QE/F1U+kctyYU69 MIEOu4f8D7rF9Uc39qvfFEo= X-Received: by 2002:a63:78b:: with SMTP id 133mr4719383pgh.307.1554825397620; Tue, 09 Apr 2019 08:56:37 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id b72sm70383560pga.86.2019.04.09.08.56.34 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 09 Apr 2019 08:56:36 -0700 (PDT) From: Changbin Du To: Bjorn Helgaas , Jonathan Corbet Cc: linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Changbin Du Subject: [PATCH v3 00/12] Include linux PCI docs into Sphinx TOC tree Date: Tue, 9 Apr 2019 23:56:14 +0800 Message-Id: <20190409155626.6049-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) 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/{MSI-HOWTO.txt => MSI-HOWTO.rst} | 83 +++--- .../{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} | 140 +++++---- .../PCI/{acpi-info.txt => acpi-info.rst} | 11 +- Documentation/PCI/endpoint/index.rst | 13 + ...-endpoint-cfs.txt => pci-endpoint-cfs.rst} | 99 ++++--- .../{pci-endpoint.txt => pci-endpoint.rst} | 95 ++++--- ...est-function.txt => pci-test-function.rst} | 32 ++- ...{pci-test-howto.txt => pci-test-howto.rst} | 81 ++++-- Documentation/PCI/index.rst | 18 ++ ...or-recovery.txt => pci-error-recovery.rst} | 178 ++++++------ .../{pci-iov-howto.txt => pci-iov-howto.rst} | 161 ++++++----- Documentation/PCI/{pci.txt => pci.rst} | 267 +++++++++--------- .../{pcieaer-howto.txt => pcieaer-howto.rst} | 110 +++++--- Documentation/index.rst | 1 + MAINTAINERS | 2 +- 15 files changed, 754 insertions(+), 537 deletions(-) rename Documentation/PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst} (88%) rename Documentation/PCI/{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} (70%) rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (97%) 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/{pci-error-recovery.txt => pci-error-recovery.rst} (80%) rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%) rename Documentation/PCI/{pci.txt => pci.rst} (78%) rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (81%) -- 2.20.1