LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH v4 00/27] Include linux x86 docs into Sphinx TOC tree
@ 2019-05-08 15:21 Changbin Du
  2019-05-08 15:21 ` [PATCH v4 01/27] Documentation: add Linux x86 docs to " Changbin Du
                   ` (27 more replies)
  0 siblings, 28 replies; 29+ messages in thread
From: Changbin Du @ 2019-05-08 15:21 UTC (permalink / raw)
  To: corbet, tglx, mingo, bp; +Cc: x86, linux-doc, linux-kernel, Changbin Du

Hi all,

The kernel now uses Sphinx to generate intelligent and beautiful documentation
from reStructuredText files. I converted all 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

Thank you!

v4: fix 2 comments for boot.rst.
v3: rebase to docs-next branch (one conflict).
v2: resolve comments from Mauro and Borislav.

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.txt => boot.rst}      | 528 ++++++----
 .../x86/{earlyprintk.txt => earlyprintk.rst}  | 122 +--
 .../x86/{entry_64.txt => entry_64.rst}        |  12 +-
 ...eption-tables.txt => exception-tables.rst} | 247 ++---
 .../x86/i386/{IO-APIC.txt => IO-APIC.rst}     |  28 +-
 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                    | 354 +++++++
 Documentation/x86/mtrr.txt                    | 329 -------
 .../{orc-unwinder.txt => orc-unwinder.rst}    |  27 +-
 Documentation/x86/pat.rst                     | 242 +++++
 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}    | 916 ++++++++++--------
 Documentation/x86/{tlb.txt => tlb.rst}        |  30 +-
 .../x86/{topology.txt => topology.rst}        |  92 +-
 ...acy-support.txt => usb-legacy-support.rst} |  40 +-
 .../{5level-paging.txt => 5level-paging.rst}  |  16 +-
 Documentation/x86/x86_64/boot-options.rst     | 335 +++++++
 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} |  12 +-
 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 -
 35 files changed, 2559 insertions(+), 2060 deletions(-)
 rename Documentation/x86/{amd-memory-encryption.txt => amd-memory-encryption.rst} (94%)
 rename Documentation/x86/{boot.txt => boot.rst} (73%)
 rename Documentation/x86/{earlyprintk.txt => earlyprintk.rst} (51%)
 rename Documentation/x86/{entry_64.txt => entry_64.rst} (95%)
 rename Documentation/x86/{exception-tables.txt => exception-tables.rst} (64%)
 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} (53%)
 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

-- 
2.20.1


^ permalink raw reply	[flat|nested] 29+ messages in thread

end of thread, other threads:[~2019-05-08 20:40 UTC | newest]

Thread overview: 29+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-08 15:21 [PATCH v4 00/27] Include linux x86 docs into Sphinx TOC tree Changbin Du
2019-05-08 15:21 ` [PATCH v4 01/27] Documentation: add Linux x86 docs to " Changbin Du
2019-05-08 15:21 ` [PATCH v4 02/27] Documentation: x86: convert boot.txt to reST Changbin Du
2019-05-08 15:21 ` [PATCH v4 03/27] Documentation: x86: convert topology.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 04/27] Documentation: x86: convert exception-tables.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 05/27] Documentation: x86: convert kernel-stacks " Changbin Du
2019-05-08 15:21 ` [PATCH v4 06/27] Documentation: x86: convert entry_64.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 07/27] Documentation: x86: convert earlyprintk.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 08/27] Documentation: x86: convert zero-page.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 09/27] Documentation: x86: convert tlb.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 10/27] Documentation: x86: convert mtrr.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 11/27] Documentation: x86: convert pat.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 12/27] Documentation: x86: convert protection-keys.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 13/27] Documentation: x86: convert intel_mpx.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 14/27] Documentation: x86: convert amd-memory-encryption.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 15/27] Documentation: x86: convert pti.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 16/27] Documentation: x86: convert microcode.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 17/27] Documentation: x86: convert resctrl_ui.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 18/27] Documentation: x86: convert orc-unwinder.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 19/27] Documentation: x86: convert usb-legacy-support.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 20/27] Documentation: x86: convert i386/IO-APIC.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 21/27] Documentation: x86: convert x86_64/boot-options.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 22/27] Documentation: x86: convert x86_64/uefi.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 23/27] Documentation: x86: convert x86_64/mm.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 24/27] Documentation: x86: convert x86_64/5level-paging.txt " Changbin Du
2019-05-08 15:21 ` [PATCH v4 25/27] Documentation: x86: convert x86_64/fake-numa-for-cpusets " Changbin Du
2019-05-08 15:21 ` [PATCH v4 26/27] Documentation: x86: convert x86_64/cpu-hotplug-spec " Changbin Du
2019-05-08 15:21 ` [PATCH v4 27/27] Documentation: x86: convert x86_64/machinecheck " Changbin Du
2019-05-08 20:40 ` [PATCH v4 00/27] Include linux x86 docs into Sphinx TOC tree Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).