Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
Em Wed, 24 Apr 2019 23:46:18 +0800 Changbin Du escreveu: > On Tue, Apr 23, 2019 at 12:36:44PM -0500, Bjorn Helgaas wrote: > > On Tue, Apr 23, 2019 at 06:39:47PM +0200, Rafael J. Wysocki wrote: > > > On Tue, Apr 23, 2019 at 6:30 PM Changbin Du wrote: > > > > Hi Corbet and All, > > > > The kernel now uses Sphinx to generate intelligent and beautiful > > > > documentation from reStructuredText files. I converted all of the Linux > > > > ACPI/PCI/X86 docs to reST format in this serias. > > > > > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > > > conversion. > > > > > > I'm not sure if combining all three into one big patch series has been > > > a good idea, honestly. > > > > Yeah, if you post this again, I would find it easier to deal with if > > linux-pci only got the PCI-related things. 63 patches is a little too > > much for one series. > > > sure, so I will resend them respectively. I reviewed up to patch 39. There are too many files on x86 that seems to be mangled by some tab->whitespace conversion, with caused very big diffs and lots of broken ascii artwork. Please ensure that the diffs will contain the minimal amount of stuff that would be required for them to be properly formatted as ReST files there. Ah, perhaps next time you could format the patches with a lower merge similarity logic (using, for example, the parameter -M10). Regards, Mauro > > > Bjorn > Thanks, Mauro
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
Em Wed, 24 Apr 2019 10:18:46 -0600 Jonathan Corbet escreveu: > On Wed, 24 Apr 2019 00:28:29 +0800 > Changbin Du wrote: > > > The kernel now uses Sphinx to generate intelligent and beautiful > > documentation > > from reStructuredText files. I converted all of the Linux ACPI/PCI/X86 docs > > to > > reST format in this serias. > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > conversion. > > As mentioned by others, this is a lot of stuff; I would really rather see > each of those groups as separate patch sets. Yeah, makes sense to me, either to split into separate patchsets or to group the changes per sub-dir (or both). > If you can do a reasonably quick turnaround with Mauro's suggestions > addressed and tags applied, we should be able to get at least some of this > into 5.2. Thanks, Mauro, for looking at all of this stuff! Anytime! Just to make clear, I'm still reviewing it... I'm at patch 35/63 now. So, expect more comments from my side. Thanks, Mauro
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
On Wed, 24 Apr 2019 00:28:29 +0800 Changbin Du wrote: > The kernel now uses Sphinx to generate intelligent and beautiful documentation > from reStructuredText files. I converted all of the Linux ACPI/PCI/X86 docs to > reST format in this serias. > > In this version I combined ACPI and PCI docs, and added new x86 docs > conversion. As mentioned by others, this is a lot of stuff; I would really rather see each of those groups as separate patch sets. If you can do a reasonably quick turnaround with Mauro's suggestions addressed and tags applied, we should be able to get at least some of this into 5.2. Thanks, Mauro, for looking at all of this stuff! Thanks, jon
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
On Tue, Apr 23, 2019 at 12:36:44PM -0500, Bjorn Helgaas wrote: > On Tue, Apr 23, 2019 at 06:39:47PM +0200, Rafael J. Wysocki wrote: > > On Tue, Apr 23, 2019 at 6:30 PM Changbin Du wrote: > > > Hi Corbet and All, > > > The kernel now uses Sphinx to generate intelligent and beautiful > > > documentation from reStructuredText files. I converted all of the Linux > > > ACPI/PCI/X86 docs to reST format in this serias. > > > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > > conversion. > > > > I'm not sure if combining all three into one big patch series has been > > a good idea, honestly. > > Yeah, if you post this again, I would find it easier to deal with if > linux-pci only got the PCI-related things. 63 patches is a little too > much for one series. > sure, so I will resend them respectively. > Bjorn -- Cheers, Changbin Du
[PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
Hi Corbet and All, The kernel now uses Sphinx to generate intelligent and beautiful documentation from reStructuredText files. I converted all of the Linux ACPI/PCI/X86 docs to reST format in this serias. In this version I combined ACPI and PCI docs, and added new x86 docs conversion. The hieararchy of ACPI docs are based on Corbet's suggestion: https://lkml.org/lkml/2019/4/3/1047 I did some adjustment according to the content and finally they are placed as: Documentation/firmware-guide/acpi/ ├── acpi-lid.rst ├── aml-debugger.rst ├── apei │ ├── einj.rst │ └── output_format.rst ├── debug.rst ├── dsd │ ├── data-node-references.rst │ └── graph.rst ├── DSD-properties-rules.rst ├── enumeration.rst ├── gpio-properties.rst ├── i2c-muxes.rst ├── lpit.rst ├── method-customizing.rst ├── method-tracing.rst ├── namespace.rst ├── osi.rst └── video_extension.rst Documentation/driver-api/acpi/ ├── linuxized-acpica.rst └── scan_handlers.rst ocumentation/admin-guide/acpi/ ├── cppc_sysfs.rst ├── dsdt-override.rst ├── initrd_table_override.rst └── ssdt-overlays.rst The PCI docs are all put into driver API guide. The X86 docs are all put into Architecture-specific documentation. For you to preview, please visit below url: http://www.bytemem.com:8080/kernel-doc/index.html Thank you! Changbin Du (63): Documentation: add Linux ACPI to Sphinx TOC tree Documentation: ACPI: move namespace.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move enumeration.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move osi.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move linuxized-acpica.txt to driver-api/acpi and convert to reST Documentation: ACPI: move scan_handlers.txt to driver-api/acpi and convert to reST Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert to reST Documentation: ACPI: move gpio-properties.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move method-customizing.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move initrd_table_override.txt to admin-guide/acpi and convert to reST Documentation: ACPI: move dsdt-override.txt to admin-guide/acpi and convert to reST Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move acpi-lid.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move dsd/graph.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move dsd/data-node-references.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move debug.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move method-tracing.txt to firmware-guide/acpi and convert to rsST Documentation: ACPI: move aml-debugger.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move apei/output_format.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move apei/einj.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST Documentation: ACPI: move lpit.txt to firmware-guide/acpi and convert to reST Documentation: ACPI: move ssdt-overlays.txt to admin-guide/acpi and convert to reST Documentation: ACPI: move video_extension.txt to firmware-guide/acpi and convert to reST 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 Documentation: add Linux x86 docs to Sphinx TOC tree Documentation: x86: convert boot.txt to reST Documentation: x86: convert topology.txt to reST Documentation: x86: convert exception-tables.txt to reST Documentation: x86: convert kernel-stacks to reST Documentation: x86: convert entry_64.txt to reST Documentation: x86: convert earlyprintk.txt to reST Documentation: x86: convert zero-page.txt to reST Documentation: x86: convert tlb.txt to reST Documentation: x86: convert mtrr.txt to reST Documentation: x86: convert pat.txt to reST Documentation: x86: convert protection-keys.txt to reST Documentation: x86: convert intel_mpx.txt to reST Documentation: x86: convert amd-memory-encryption.txt to reST Documentation: x86: convert pti.txt to reST Documentation: x86: convert microcode.txt to
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
On Tue, Apr 23, 2019 at 06:39:47PM +0200, Rafael J. Wysocki wrote: > On Tue, Apr 23, 2019 at 6:30 PM Changbin Du wrote: > > Hi Corbet and All, > > The kernel now uses Sphinx to generate intelligent and beautiful > > documentation from reStructuredText files. I converted all of the Linux > > ACPI/PCI/X86 docs to reST format in this serias. > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > conversion. > > I'm not sure if combining all three into one big patch series has been > a good idea, honestly. Yeah, if you post this again, I would find it easier to deal with if linux-pci only got the PCI-related things. 63 patches is a little too much for one series. Bjorn
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
On Tue, Apr 23, 2019 at 6:30 PM Changbin Du wrote: > > Hi Corbet and All, > The kernel now uses Sphinx to generate intelligent and beautiful documentation > from reStructuredText files. I converted all of the Linux ACPI/PCI/X86 docs to > reST format in this serias. > > In this version I combined ACPI and PCI docs, and added new x86 docs > conversion. I'm not sure if combining all three into one big patch series has been a good idea, honestly. It would have been easier to review and handle otherwise. For one, I'd like to handle the ACPI part of it myself if Jon doesn't mind that. Thanks, Rafael
