Include linux PCI docs into Sphinx TOC tree
Subsystems (5)
v6 cover Include linux PCI docs into Sphinx TOC tree
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)
v6: fix comments.
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} | 92 +++--
...est-function.txt => pci-test-function.rst} | 84 +++--
...{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, 938 insertions(+), 710 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} (83%)
rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%)
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%)Signature · 1 line
2.20.1
PATCH v6 1/12 Documentation: add Linux PCI to Sphinx TOC tree
Add a index.rst for PCI subsystem. More docs will be added later.
--- Documentation/PCI/index.rst | 9 +++++++++ Documentation/index.rst | 1 + 2 files changed, 10 insertions(+) create mode 100644 Documentation/PCI/index.rst
Documentation/PCI/index.rst new file +9 -0
@@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================= +Linux PCI Bus Subsystem +======================= + +.. toctree:: + :maxdepth: 2 + :numbered:
Documentation/index.rst +1 -0
@@ -101,6 +101,7 @@ needed). filesystems/index vm/index bpf/index + PCI/index misc-devices/index Architecture-specific documentation
Signature · 1 line
2.20.1
PATCH v6 2/12 Documentation: PCI: convert pci.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
The description about struct pci_driver and struct pci_device_id are moved into in-source comments.
---
Documentation/PCI/index.rst | 2 +
Documentation/PCI/{pci.txt => pci.rst} | 356 +++++++++++--------------
include/linux/mod_devicetable.h | 19 ++
include/linux/pci.h | 37 +++
4 files changed, 207 insertions(+), 207 deletions(-)
rename Documentation/PCI/{pci.txt => pci.rst} (68%)Documentation/PCI/index.rst +2 -0
@@ -7,3 +7,5 @@ Linux PCI Bus Subsystem .. toctree:: :maxdepth: 2 :numbered: + + pci
Documentation/PCI/pci.rst renamed from Documentation/PCI/pci.txt +149 -207
613 lines not on this page · raw message
include/linux/mod_devicetable.h +19 -0
@@ -16,6 +16,25 @@ typedef unsigned long kernel_ulong_t;#define PCI_ANY_ID (~0) +/** +* struct pci_device_id - PCI device ID structure +* @vendor: Vendor ID to match (or PCI_ANY_ID) +* @device: Device ID to match (or PCI_ANY_ID) +* @subvendor: Subsystem vendor ID to match (or PCI_ANY_ID) +* @subdevice: Subsystem device ID to match (or PCI_ANY_ID) +* @class: Device class, subclass, and "interface" to match. +* See Appendix D of the PCI Local Bus Spec or +* include/linux/pci_ids.h for a full list of classes. +* Most drivers do not need to specify class/class_mask +* as vendor/device is normally sufficient. +* @class_mask: limit which sub-fields of the class field are compared. +* See drivers/scsi/sym53c8xx_2/ for example of usage. +* @driver_data: Data private to the driver. +* Most drivers don't need to use driver_data field. +* Best practice is to use driver_data as an index +* into a static list of equivalent device types, +* instead of using it as a pointer. +*/ struct pci_device_id {__u32 vendor, device;/* Vendor and device ID or PCI_ANY_ID*/ __u32 subvendor, subdevice;/* Subsystem ID's or PCI_ANY_ID */
include/linux/pci.h +37 -0
@@ -767,6 +767,43 @@ struct pci_error_handlers {struct module ; + +/** +* struct pci_driver - PCI driver structure +* @id_table: Pointer to table of device ID's the driver is +* interested in. Most drivers should export this +* table using MODULE_DEVICE_TABLE(pci,...). +* @probe: This probing function gets called (during execution +* of pci_register_driver() for already existing +* devices or later if a new device gets inserted) for +* all PCI devices which match the ID table and are not +* "owned" by the other drivers yet. This function gets +* passed a "struct pci_dev *" for each device whose +* entry in the ID table matches the device. The probe +* function returns zero when the driver chooses to +* take "ownership" of the device or an error code +* (negative number) otherwise. +* The probe function always gets called from process +* context, so it can sleep. +* @remove: The remove() function gets called whenever a device +* being handled by this driver is removed (either during +* deregistration of the driver or when it's manually +* pulled out of a hot-pluggable slot). +* The remove function always gets called from process +* context, so it can sleep. +* @suspend: Put device into low power state. +* @suspend_late: Put device into low power state. +* @resume_early: Wake device from low power state. +* @resume: Wake device from low power state. +* (Please see Documentation/power/pci.txt for descriptions +* of PCI Power Management and the related functions.) +* @shutdown: Hook into reboot_notifier_list (kernel/sys.c). +* Intended to stop any idling DMA operations. +* Useful for enabling wake-on-lan (NIC) or changing +* the power state of a device before reboot. +* e.g. drivers/net/e100.c. +* @err_handler: See Documentation/PCI/pci-error-recovery.rst +*/ struct pci_driver {struct list_head node;const char *name;
Signature · 1 line
2.20.1
PATCH v6 3/12 Documentation: PCI: convert PCIEBUS-HOWTO.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/index.rst | 1 +
.../{PCIEBUS-HOWTO.txt => picebus-howto.rst} | 140 ++++++++++--------
2 files changed, 82 insertions(+), 59 deletions(-)
rename Documentation/PCI/{PCIEBUS-HOWTO.txt => picebus-howto.rst} (70%)Documentation/PCI/index.rst +1 -0
@@ -9,3 +9,4 @@ Linux PCI Bus Subsystem :numbered: pci + picebus-howto
Documentation/PCI/picebus-howto.rst renamed from Documentation/PCI/PCIEBUS-HOWTO.txt +81 -59
224 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 4/12 Documentation: PCI: convert pci-iov-howto.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/index.rst | 1 +
.../{pci-iov-howto.txt => pci-iov-howto.rst} | 161 ++++++++++--------
2 files changed, 94 insertions(+), 68 deletions(-)
rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%)Documentation/PCI/index.rst +1 -0
@@ -10,3 +10,4 @@ Linux PCI Bus Subsystem pci picebus-howto + pci-iov-howto
Documentation/PCI/pci-iov-howto.rst renamed from Documentation/PCI/pci-iov-howto.txt +93 -68
221 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 5/12 Documentation: PCI: convert MSI-HOWTO.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
v2:
o drop numbering.
o simplify author list
---
Documentation/PCI/index.rst | 1 +
.../PCI/{MSI-HOWTO.txt => msi-howto.rst} | 85 +++++++++++--------
2 files changed, 52 insertions(+), 34 deletions(-)
rename Documentation/PCI/{MSI-HOWTO.txt => msi-howto.rst} (88%)Documentation/PCI/index.rst +1 -0
@@ -11,3 +11,4 @@ Linux PCI Bus Subsystem pci picebus-howto pci-iov-howto + msi-howto
Documentation/PCI/msi-howto.rst renamed from Documentation/PCI/MSI-HOWTO.txt +51 -34
221 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 6/12 Documentation: PCI: convert acpi-info.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
.../PCI/{acpi-info.txt => acpi-info.rst} | 15 ++++++++++-----
Documentation/PCI/index.rst | 1 +
2 files changed, 11 insertions(+), 5 deletions(-)
rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (96%)Documentation/PCI/acpi-info.rst renamed from Documentation/PCI/acpi-info.txt +10 -5
@@ -1,4 +1,8 @@ - ACPI considerations for PCI host bridges +.. SPDX-License-Identifier: GPL-2.0 + +======================================== +ACPI considerations for PCI host bridges +======================================== The general rule is that the ACPI namespace should describe everything the OS might use unless there's another way for the OS to find it [1, 2].
@@ -131,12 +135,13 @@ address always corresponds to bus 0, even if the bus range below the bridge [4] ACPI 6.2, sec 6.4.3.5.1, 2, 3, 4: QWord/DWord/Word Address Space Descriptor (.1, .2, .3) - General Flags: Bit [0] Ignored + General Flags: Bit [0] Ignored Extended Address Space Descriptor (.4) - General Flags: Bit [0] Consumer/Producer: - 1–This device consumes this resource - 0–This device produces and consumes this resource + General Flags: Bit [0] Consumer/Producer: + + * 1 – This device consumes this resource + * 0 – This device produces and consumes this resource [5] ACPI 6.2, sec 19.6.43: ResourceUsage specifies whether the Memory range is consumed by
Documentation/PCI/index.rst +1 -0
@@ -12,3 +12,4 @@ Linux PCI Bus Subsystem picebus-howto pci-iov-howto msi-howto + acpi-info
Signature · 1 line
2.20.1
PATCH v6 7/12 Documentation: PCI: convert pci-error-recovery.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/index.rst | 1 +
...or-recovery.txt => pci-error-recovery.rst} | 287 +++++++++---------
MAINTAINERS | 4 +-
3 files changed, 152 insertions(+), 140 deletions(-)
rename Documentation/PCI/{pci-error-recovery.txt => pci-error-recovery.rst} (67%)Documentation/PCI/index.rst +1 -0
@@ -13,3 +13,4 @@ Linux PCI Bus Subsystem pci-iov-howto msi-howto acpi-info + pci-error-recovery
Documentation/PCI/pci-error-recovery.rst renamed from Documentation/PCI/pci-error-recovery.txt +149 -138
348 lines not on this page · raw message
MAINTAINERS +2 -2
@@ -12101,7 +12101,7 @@ M: Sam Bobroff <[email protected]> M: Oliver O'Halloran <[email protected]> L: [email protected] S: Supported -F: Documentation/PCI/pci-error-recovery.txt +F: Documentation/PCI/pci-error-recovery.rst F: drivers/pci/pcie/aer.c F: drivers/pci/pcie/dpc.c F: drivers/pci/pcie/err.c
@@ -12114,7 +12114,7 @@ PCI ERROR RECOVERY M: Linas Vepstas <[email protected]> L: [email protected] S: Supported -F: Documentation/PCI/pci-error-recovery.txt +F: Documentation/PCI/pci-error-recovery.rst PCI MSI DRIVER FOR ALTERA MSI IP M: Ley Foon Tan <[email protected]>
Signature · 1 line
2.20.1
PATCH v6 8/12 Documentation: PCI: convert pcieaer-howto.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/index.rst | 1 +
.../{pcieaer-howto.txt => pcieaer-howto.rst} | 156 +++++++++++-------
2 files changed, 101 insertions(+), 56 deletions(-)
rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (72%)Documentation/PCI/index.rst +1 -0
@@ -14,3 +14,4 @@ Linux PCI Bus Subsystem msi-howto acpi-info pci-error-recovery + pcieaer-howto
Documentation/PCI/pcieaer-howto.rst renamed from Documentation/PCI/pcieaer-howto.txt +100 -56
283 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 9/12 Documentation: PCI: convert endpoint/pci-endpoint.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/endpoint/index.rst | 10 ++
.../{pci-endpoint.txt => pci-endpoint.rst} | 92 +++++++++++--------
Documentation/PCI/index.rst | 1 +
3 files changed, 65 insertions(+), 38 deletions(-)
create mode 100644 Documentation/PCI/endpoint/index.rst
rename Documentation/PCI/endpoint/{pci-endpoint.txt => pci-endpoint.rst} (83%)Documentation/PCI/endpoint/index.rst new file +10 -0
@@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0 + +====================== +PCI Endpoint Framework +====================== + +.. toctree:: + :maxdepth: 2 + + pci-endpoint
Documentation/PCI/endpoint/pci-endpoint.rst renamed from Documentation/PCI/endpoint/pci-endpoint.txt +54 -38
251 lines not on this page · raw message
Documentation/PCI/index.rst +1 -0
@@ -15,3 +15,4 @@ Linux PCI Bus Subsystem acpi-info pci-error-recovery pcieaer-howto + endpoint/index
Signature · 1 line
2.20.1
PATCH v6 10/12 Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/endpoint/index.rst | 1 +
...-endpoint-cfs.txt => pci-endpoint-cfs.rst} | 99 +++++++++++--------
2 files changed, 57 insertions(+), 43 deletions(-)
rename Documentation/PCI/endpoint/{pci-endpoint-cfs.txt => pci-endpoint-cfs.rst} (64%)Documentation/PCI/endpoint/index.rst +1 -0
@@ -8,3 +8,4 @@ PCI Endpoint Framework :maxdepth: 2 pci-endpoint + pci-endpoint-cfs
Documentation/PCI/endpoint/pci-endpoint-cfs.rst renamed from Documentation/PCI/endpoint/pci-endpoint-cfs.txt +56 -43
142 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 11/12 Documentation: PCI: convert endpoint/pci-test-function.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/endpoint/index.rst | 1 +
...est-function.txt => pci-test-function.rst} | 84 +++++++++++--------
2 files changed, 51 insertions(+), 34 deletions(-)
rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%)Documentation/PCI/endpoint/index.rst +1 -0
@@ -9,3 +9,4 @@ PCI Endpoint Framework pci-endpoint pci-endpoint-cfs + pci-test-function
Documentation/PCI/endpoint/pci-test-function.rst renamed from Documentation/PCI/endpoint/pci-test-function.txt +50 -34
120 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v6 12/12 Documentation: PCI: convert endpoint/pci-test-howto.txt to reST
In reply to Changbin DuThis converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.
---
Documentation/PCI/endpoint/index.rst | 1 +
...{pci-test-howto.txt => pci-test-howto.rst} | 81 +++++++++++++------
2 files changed, 56 insertions(+), 26 deletions(-)
rename Documentation/PCI/endpoint/{pci-test-howto.txt => pci-test-howto.rst} (78%)Documentation/PCI/endpoint/index.rst +1 -0
@@ -10,3 +10,4 @@ PCI Endpoint Framework pci-endpoint pci-endpoint-cfs pci-test-function + pci-test-howto
Documentation/PCI/endpoint/pci-test-howto.rst renamed from Documentation/PCI/endpoint/pci-test-howto.txt +55 -26
167 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [PATCH v6 12/12] Documentation: PCI: convert endpoint/pci-test-howto.txt to reST
Quoted 9 lines · Changbin Du
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 <[email protected]>Acked-by Bjorn Helgaas <[email protected]>Reviewed-by Mauro Carvalho Chehab <[email protected]>
Documentation/PCI/endpoint/pci-test-howto.rst configurable fields. · line 76
Quoted 5 lines
Documentation/PCI/endpoint/pci-test-howto.rst renamed from Documentation/PCI/endpoint/pci-test-howto.txt +3
-1-1.4 Configuring pci-epf-test Device + +Configuring pci-epf-test Device +-------------------------------
This removed the "1.4" anchor for a subsequent reference:
Documentation/PCI/endpoint/pci-test-howto.rst configurable fields. · line 120
Quoted 5 lines
Documentation/PCI/endpoint/pci-test-howto.rst renamed from Documentation/PCI/endpoint/pci-test-howto.txt +2
-0+Note that the devices listed here correspond to the value populated in 1.4 +above:: 00:00.0 PCI bridge: Texas Instruments Device 8888 (rev 01) 01:00.0 Unassigned class [ff00]: Texas Instruments Device b500
The text still contains "populated in 1.4 above", but "1.4" doesn't exist anymore, so it doesn't point to anything.
I don't know the right way to make that reference in reST, but maybe you do?
Bjorn
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.
Quoted 66 lines · Changbin Du
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.htmlThank you!
v2: trivial style update.
v3: update titles. (Bjorn Helgaas)
v4: fix comments from Mauro Carvalho Chehab
v5: updateMAINTAINERS(Joe Perches)
v6: fix comments.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: convertendpoint/pci-endpoint.txtto reST
Documentation: PCI: convertendpoint/pci-endpoint-cfs.txtto reST
Documentation: PCI: convertendpoint/pci-test-function.txtto reST
Documentation: PCI: convertendpoint/pci-test-howto.txtto 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} | 92 +++-- ...est-function.txt => pci-test-function.rst} | 84 +++-- ...{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, 938 insertions(+), 710 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} (83%) rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%) 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%)Signature · 1 line
2.20.1
Signature · 2 lines
Cheers, Changbin Du
Em Mon, 20 May 2019 06:10:15 +0000
Changbin Du <[email protected]> escreveu:
Quoted 2 lines
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.
Before merging it, did you check if the renames won't cause broken reference links? There were such breakages with your x86 and acpi patch series. I'm sending the fixes right now, but it would be great if you could run the ./scripts/documentation-file-ref-check script and address any file name change this series would be introducing. There's even a --fix option there that allows to automatically fix them (you need to double-check the results).
Regards,
Mauro
Quoted 65 lines · Changbin Du
Quoted 63 lines
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.htmlThank you!
v2: trivial style update.
v3: update titles. (Bjorn Helgaas)
v4: fix comments from Mauro Carvalho Chehab
v5: updateMAINTAINERS(Joe Perches)
v6: fix comments.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: convertendpoint/pci-endpoint.txtto reST
Documentation: PCI: convertendpoint/pci-endpoint-cfs.txtto reST
Documentation: PCI: convertendpoint/pci-test-function.txtto reST
Documentation: PCI: convertendpoint/pci-test-howto.txtto 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} | 92 +++-- ...est-function.txt => pci-test-function.rst} | 84 +++-- ...{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, 938 insertions(+), 710 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} (83%) rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%) 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%)
Quoted 4 lines
Quoted 3 lines
Signature · 1 line
2.20.1
Thanks,
Mauro
Quoted 6 lines · Mauro Carvalho Chehab
Em Mon, 20 May 2019 06:10:15 +0000
Changbin Du <[email protected]> escreveu:Quoted 2 lines
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.
Quoted 8 lines
Before merging it, did you check if the renames won't cause broken reference links? There were such breakages with your x86 and acpi patch series. I'm sending the fixes right now, but it would be great if you could run the
./scripts/documentation-file-ref-checkscript and address any file name change this series would be introducing. There's even a --fix option there that allows to automatically fix them (you need to double-check the results).
I just ran documentation-file-ref-check, and *no* broken reference found in PCI documentation. This tool is great!
Quoted 77 lines
Regards,
MauroQuoted 65 lines · Changbin Du
Quoted 63 lines
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.htmlThank you!
v2: trivial style update.
v3: update titles. (Bjorn Helgaas)
v4: fix comments from Mauro Carvalho Chehab
v5: updateMAINTAINERS(Joe Perches)
v6: fix comments.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: convertendpoint/pci-endpoint.txtto reST
Documentation: PCI: convertendpoint/pci-endpoint-cfs.txtto reST
Documentation: PCI: convertendpoint/pci-test-function.txtto reST
Documentation: PCI: convertendpoint/pci-test-howto.txtto 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} | 92 +++-- ...est-function.txt => pci-test-function.rst} | 84 +++-- ...{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, 938 insertions(+), 710 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} (83%) rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%) 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%)Quoted 4 lines
Quoted 3 lines
Signature · 1 line
2.20.1Thanks,
Mauro
Signature · 2 lines
Cheers, Changbin Du
Jonathan Corbet
maintainerQuoted 2 lines · On Mon, 20 May 2019 06:10:15 +0000 Changbin Du <[email protected]> wrote:
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.
Somewhat belatedly, but I think we could. Bjorn, do you have a preference for which tree this goes through? I don't remember if we'd come to an agreement on that or not, sorry...
Thanks,
jon
Quoted 9 lines · Jonathan Corbet
Quoted 2 lines · On Mon, 20 May 2019 06:10:15 +0000 Changbin Du <[email protected]> wrote:
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.Somewhat belatedly, but I think we could. Bjorn, do you have a preference for which tree this goes through? I don't remember if we'd come to an agreement on that or not, sorry...
I don't have a preference. I somehow had the impression it would go through your tree, but I'd be happy to merge it if you'd prefer.
Bjorn
Quoted 9 lines · Jonathan Corbet
Quoted 2 lines · On Mon, 20 May 2019 06:10:15 +0000 Changbin Du <[email protected]> wrote:
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.Somewhat belatedly, but I think we could. Bjorn, do you have a preference for which tree this goes through? I don't remember if we'd come to an agreement on that or not, sorry...
Actually, let me at least take a look at these. I noticed that renames caused some of the ACPI docs to end up with lines >80 columns, and I'd prefer to avoid that. So maybe I'll take these after all if that's OK.
Bjorn
Bjorn Helgaas
AppliedQuoted 7 lines · Bjorn Helgaas
Quoted 6 lines · Jonathan Corbet
Quoted 2 lines · On Mon, 20 May 2019 06:10:15 +0000 Changbin Du <[email protected]> wrote:
Bjorn and Jonathan,
Could we consider to merge this serias now? Thanks.
Quoted 8 lines
Quoted 3 lines
Somewhat belatedly, but I think we could. Bjorn, do you have a preference for which tree this goes through? I don't remember if we'd come to an agreement on that or not, sorry...
Actually, let me at least take a look at these. I noticed that renames caused some of the ACPI docs to end up with lines >80 columns, and I'd prefer to avoid that. So maybe I'll take these after all if that's OK.
I applied these to pci/docs for v5.3, thanks!