Re: [PATCH 00/27] Include linux x86 docs into Sphinx TOC tree

[Mauro Carvalho Chehab <mchehab+samsung@kernel.org>]

Em Fri, 26 Apr 2019 23:31:23 +0800
Changbin Du <changbin.du@gmail.com> escreveu:

> Hi all,
> 
> The kernel now uses Sphinx to generate intelligent and beautiful documentation
> from reStructuredText files. I converted most of the Linux x86 docs to rst
> format in this serias.
> 
> For you to preview, please visit below url:
> http://www.bytemem.com:8080/kernel-doc/index.html

Do you have a URL for the git tree? It is probably easier to merge from
it on a tem branch locally, specially for some patches like 02/27, were 
git didn't understand the conversion as a rename.

> 
> Thank you!
> 
> Changbin Du (27):
>   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 reST
>   Documentation: x86: convert resctrl_ui.txt to reST
>   Documentation: x86: convert orc-unwinder.txt to reST
>   Documentation: x86: convert usb-legacy-support.txt to reST
>   Documentation: x86: convert i386/IO-APIC.txt to reST
>   Documentation: x86: convert x86_64/boot-options.txt to reST
>   Documentation: x86: convert x86_64/uefi.txt to reST
>   Documentation: x86: convert x86_64/mm.txt to reST
>   Documentation: x86: convert x86_64/5level-paging.txt to reST
>   Documentation: x86: convert x86_64/fake-numa-for-cpusets to reST
>   Documentation: x86: convert x86_64/cpu-hotplug-spec to reST
>   Documentation: x86: convert x86_64/machinecheck to reST
> 
>  Documentation/index.rst                       |    1 +
>  ...cryption.txt => amd-memory-encryption.rst} |   13 +-
>  Documentation/x86/boot.rst                    | 1238 +++++++++++++++++
>  Documentation/x86/boot.txt                    | 1130 ---------------
>  .../x86/{earlyprintk.txt => earlyprintk.rst}  |  103 +-
>  .../x86/{entry_64.txt => entry_64.rst}        |   12 +-
>  ...eption-tables.txt => exception-tables.rst} |  231 +--
>  .../x86/i386/{IO-APIC.txt => IO-APIC.rst}     |   26 +-
>  Documentation/x86/i386/index.rst              |   10 +
>  Documentation/x86/index.rst                   |   30 +
>  .../x86/{intel_mpx.txt => intel_mpx.rst}      |  120 +-
>  .../x86/{kernel-stacks => kernel-stacks.rst}  |   20 +-
>  .../x86/{microcode.txt => microcode.rst}      |   62 +-
>  Documentation/x86/mtrr.rst                    |  350 +++++
>  Documentation/x86/mtrr.txt                    |  329 -----
>  .../{orc-unwinder.txt => orc-unwinder.rst}    |   27 +-
>  Documentation/x86/pat.rst                     |  235 ++++
>  Documentation/x86/pat.txt                     |  230 ---
>  ...rotection-keys.txt => protection-keys.rst} |   33 +-
>  Documentation/x86/{pti.txt => pti.rst}        |   17 +-
>  .../x86/{resctrl_ui.txt => resctrl_ui.rst}    |  913 ++++++------
>  Documentation/x86/{tlb.txt => tlb.rst}        |   30 +-
>  .../x86/{topology.txt => topology.rst}        |   92 +-
>  ...acy-support.txt => usb-legacy-support.rst} |    8 +-
>  .../{5level-paging.txt => 5level-paging.rst}  |   16 +-
>  Documentation/x86/x86_64/boot-options.rst     |  326 +++++
>  Documentation/x86/x86_64/boot-options.txt     |  278 ----
>  ...{cpu-hotplug-spec => cpu-hotplug-spec.rst} |    5 +-
>  ...-for-cpusets => fake-numa-for-cpusets.rst} |   25 +-
>  Documentation/x86/x86_64/index.rst            |   16 +
>  .../x86_64/{machinecheck => machinecheck.rst} |   11 +-
>  Documentation/x86/x86_64/mm.rst               |  161 +++
>  Documentation/x86/x86_64/mm.txt               |  153 --
>  .../x86/x86_64/{uefi.txt => uefi.rst}         |   30 +-
>  Documentation/x86/zero-page.rst               |   45 +
>  Documentation/x86/zero-page.txt               |   40 -
>  36 files changed, 3412 insertions(+), 2954 deletions(-)
>  rename Documentation/x86/{amd-memory-encryption.txt => amd-memory-encryption.rst} (94%)
>  create mode 100644 Documentation/x86/boot.rst
>  delete mode 100644 Documentation/x86/boot.txt
>  rename Documentation/x86/{earlyprintk.txt => earlyprintk.rst} (59%)
>  rename Documentation/x86/{entry_64.txt => entry_64.rst} (95%)
>  rename Documentation/x86/{exception-tables.txt => exception-tables.rst} (67%)
>  rename Documentation/x86/i386/{IO-APIC.txt => IO-APIC.rst} (93%)
>  create mode 100644 Documentation/x86/i386/index.rst
>  create mode 100644 Documentation/x86/index.rst
>  rename Documentation/x86/{intel_mpx.txt => intel_mpx.rst} (75%)
>  rename Documentation/x86/{kernel-stacks => kernel-stacks.rst} (92%)
>  rename Documentation/x86/{microcode.txt => microcode.rst} (81%)
>  create mode 100644 Documentation/x86/mtrr.rst
>  delete mode 100644 Documentation/x86/mtrr.txt
>  rename Documentation/x86/{orc-unwinder.txt => orc-unwinder.rst} (93%)
>  create mode 100644 Documentation/x86/pat.rst
>  delete mode 100644 Documentation/x86/pat.txt
>  rename Documentation/x86/{protection-keys.txt => protection-keys.rst} (83%)
>  rename Documentation/x86/{pti.txt => pti.rst} (96%)
>  rename Documentation/x86/{resctrl_ui.txt => resctrl_ui.rst} (68%)
>  rename Documentation/x86/{tlb.txt => tlb.rst} (81%)
>  rename Documentation/x86/{topology.txt => topology.rst} (74%)
>  rename Documentation/x86/{usb-legacy-support.txt => usb-legacy-support.rst} (92%)
>  rename Documentation/x86/x86_64/{5level-paging.txt => 5level-paging.rst} (91%)
>  create mode 100644 Documentation/x86/x86_64/boot-options.rst
>  delete mode 100644 Documentation/x86/x86_64/boot-options.txt
>  rename Documentation/x86/x86_64/{cpu-hotplug-spec => cpu-hotplug-spec.rst} (88%)
>  rename Documentation/x86/x86_64/{fake-numa-for-cpusets => fake-numa-for-cpusets.rst} (85%)
>  create mode 100644 Documentation/x86/x86_64/index.rst
>  rename Documentation/x86/x86_64/{machinecheck => machinecheck.rst} (92%)
>  create mode 100644 Documentation/x86/x86_64/mm.rst
>  delete mode 100644 Documentation/x86/x86_64/mm.txt
>  rename Documentation/x86/x86_64/{uefi.txt => uefi.rst} (79%)
>  create mode 100644 Documentation/x86/zero-page.rst
>  delete mode 100644 Documentation/x86/zero-page.txt
> 



Thanks,
Mauro