This patch series continues the efforts of converting the Linux Kernel
documentation to Sphinx.
It contains text to ReST conversion of several files under Documentation,
and a few ones under the main dir (README, REPORTING-BUGS).
All patches on this series can be found on my development tree:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=lkml-books-v2
The Kernel docs html output after this series can be seen at:
https://mchehab.fedorapeople.org/kernel_docs/
---
version 3:
- Rebased on the top of docs-next branch;
- Re-added TOC at module-signing.txt, marked as comments;
- Added module-signing.txt to the admin-guide book.
version 2:
- The development process book was renamed:
Documentation/development-process -> Documentation/process
- The User's manual book is now at Documentation/admin-guide;
- Files were physically moved to the corresponding directory;
- Added SubmittingPatches and CodingStyle on the previously location, pointing
to the new location;
- As the README file was moved to Documentation/admin-guide/README.rst, a new
README file was added, in order to point to the new location and to provide a
quick summary about the Kernel's documentation;
- All rst files added in this series use the "foo-bar.rst" nomenclature,
instead of
CamelCase or foo_bar;
- As the files now got moved, added a patch fixing the location of the files
within
the Kernel tree.
Mauro Carvalho Chehab (37):
Documentation/applying-patches.txt: fix a bad external link
Documentation/adding-syscalls.txt: convert it to ReST markup
Documentation/kernel-parameters.txt: convert to ReST markup
Documentation/bad_memory.txt: convert it to ReST markup
Documentation/basic_profiling.rst: convert to ReST markup
Documentation/binfmt_misc.txt: convert it to ReST markup
Documentation/serial-console.txt: convert it to ReST markup
Documentation/braille-console: convert it to ReST markup
Documentation/BUG-HUNTING: convert to ReST markup
Documentation/devices.rst: convert it to ReST markup
Documentation/dynamic-debug-howto.txt: convert it to ReST markup
Documentation/initrd.txt: convert to ReST markup
Documentation/init.txt: convert to ReST markup
Documentation/magic-number.txt: convert it to ReST markup
Documentation/md.txt: Convert to ReST markup
Documentation/module-signing.txt: convert to ReST markup
Documentation/mono.txt: convert to ReST markup
Documentation/java.txt: convert to ReST markup
Documentation/oops-tracing.txt: convert to ReST markup
Documentation/parport.txt: convert to ReST markup
Documentation/ramoops.txt: convert it to ReST format
Documentation/sysfs-rules.txt: convert it to ReST markup
Documentation/sysrq.txt: convert to ReST markup
Documentation/unicode.txt: convert it to ReST markup
Documentation/VGA-softcursor.txt: convert to ReST markup
Documentation/volatile-considered-harmful.txt: convert to ReST markup
Documentation/parport.txt: fix table to show on LaTeX
Documentation/CodeOfConflict: convert to ReST
REPORTING-BUGS: convert to ReST markup
README: convert it to ReST markup
docs: rename development-process/ to process/
docs-rst: add documents to development-process
docs-rst: create an user's manual book
docs: fix locations of several documents that got moved
doc: re-add CodingStyle and SubmittingPatches
README: add a new README file, pointing to the Documentation/
Documentation/00-INDEX: remove legacy media directories
Documentation/00-INDEX | 60 +-
Documentation/ABI/README | 2 +-
Documentation/ABI/testing/sysfs-kernel-slab | 2 +-
Documentation/CodingStyle | 1063 +------------------
Documentation/DocBook/kernel-hacking.tmpl | 4 +-
Documentation/SubmittingPatches | 842 +--------------
Documentation/VGA-softcursor.txt | 39 -
Documentation/acpi/video_extension.txt | 2 +-
Documentation/admin-guide/README.rst | 411 ++++++++
.../{bad_memory.txt => admin-guide/bad-memory.rst} | 25 +-
Documentation/admin-guide/basic-profiling.rst | 68 ++
Documentation/admin-guide/binfmt-misc.rst | 151 +++
Documentation/admin-guide/braille-console.rst | 38 +
.../{BUG-HUNTING => admin-guide/bug-hunting.rst} | 163 +--
Documentation/admin-guide/conf.py | 10 +
.../{devices.txt => admin-guide/devices.rst} | 1091 ++++++++++----------
Documentation/admin-guide/dynamic-debug-howto.rst | 353 +++++++
Documentation/admin-guide/index.rst | 34 +
Documentation/{init.txt => admin-guide/init.rst} | 29 +-
.../{initrd.txt => admin-guide/initrd.rst} | 199 ++--
Documentation/{java.txt => admin-guide/java.rst} | 245 ++---
.../kernel-parameters.rst} | 39 +-
Documentation/{md.txt => admin-guide/md.rst} | 528 ++++++----
.../module-signing.rst} | 126 +--
Documentation/{mono.txt => admin-guide/mono.rst} | 44 +-
.../oops-tracing.rst} | 255 ++---
Documentation/admin-guide/parport.rst | 286 +++++
.../{ramoops.txt => admin-guide/ramoops.rst} | 86 +-
.../admin-guide/reporting-bugs.rst | 68 +-
.../security-bugs.rst} | 14 +-
.../serial-console.rst} | 68 +-
Documentation/admin-guide/sysfs-rules.rst | 192 ++++
Documentation/admin-guide/sysrq.rst | 289 ++++++
.../{unicode.txt => admin-guide/unicode.rst} | 24 +-
Documentation/admin-guide/vga-softcursor.rst | 66 ++
Documentation/arm/Booting | 2 +-
Documentation/atomic_ops.txt | 2 +-
Documentation/basic_profiling.txt | 56 -
Documentation/binfmt_misc.txt | 131 ---
Documentation/blockdev/ramdisk.txt | 2 +-
Documentation/braille-console.txt | 34 -
Documentation/cgroup-v1/00-INDEX | 2 +-
Documentation/conf.py | 4 +-
Documentation/development-process/index.rst | 9 -
.../devicetree/bindings/rtc/maxim,ds3231.txt | 2 +-
Documentation/devicetree/bindings/rtc/pcf8563.txt | 2 +-
.../devicetree/bindings/submitting-patches.txt | 2 +-
Documentation/dynamic-debug-howto.txt | 340 ------
Documentation/filesystems/locks.txt | 2 +-
Documentation/filesystems/nfs/nfsroot.txt | 4 +-
Documentation/frv/booting.txt | 2 +-
Documentation/hwmon/submitting-patches | 8 +-
Documentation/index.rst | 3 +-
Documentation/isdn/README | 2 +-
Documentation/ja_JP/HOWTO | 24 +-
Documentation/ja_JP/SubmitChecklist | 8 +-
Documentation/ja_JP/SubmittingPatches | 18 +-
Documentation/ja_JP/stable_api_nonsense.txt | 4 +-
Documentation/ja_JP/stable_kernel_rules.txt | 6 +-
Documentation/kernel-per-CPU-kthreads.txt | 2 +-
Documentation/ko_KR/HOWTO | 30 +-
Documentation/ko_KR/stable_api_nonsense.txt | 4 +-
Documentation/lockup-watchdogs.txt | 4 +-
Documentation/m68k/kernel-options.txt | 2 +-
Documentation/magic-number.txt | 158 ---
Documentation/media/uapi/v4l/diff-v4l.rst | 4 +-
Documentation/media/v4l-drivers/bttv.rst | 4 +-
Documentation/memory-hotplug.txt | 2 +-
Documentation/networking/netconsole.txt | 2 +-
Documentation/networking/netdev-FAQ.txt | 8 +-
Documentation/networking/vortex.txt | 2 +-
Documentation/parport.txt | 267 -----
Documentation/power/00-INDEX | 2 +-
Documentation/power/pci.txt | 10 +-
Documentation/power/runtime_pm.txt | 2 +-
Documentation/power/swsusp-dmcrypt.txt | 2 +-
.../{development-process => process}/1.Intro.rst | 0
.../{development-process => process}/2.Process.rst | 0
.../3.Early-stage.rst | 0
.../{development-process => process}/4.Coding.rst | 4 +-
.../{development-process => process}/5.Posting.rst | 12 +-
.../6.Followthrough.rst | 0
.../7.AdvancedTopics.rst | 2 -
.../8.Conclusion.rst | 6 +-
.../adding-syscalls.rst} | 263 ++---
.../applying-patches.rst} | 3 +-
Documentation/{Changes => process/changes.rst} | 0
.../code-of-conflict.rst} | 3 +-
Documentation/process/coding-style.rst | 1062 +++++++++++++++++++
.../{development-process => process}/conf.py | 2 +-
.../development-process.rst | 1 -
.../email-clients.rst} | 0
Documentation/{HOWTO => process/howto.rst} | 24 +-
Documentation/process/index.rst | 32 +
.../{kernel-docs.txt => process/kernel-docs.rst} | 0
Documentation/process/magic-number.rst | 164 +++
.../management-style.rst} | 2 +-
.../stable-api-nonsense.rst} | 0
.../stable-kernel-rules.rst} | 4 +-
.../submit-checklist.rst} | 6 +-
.../submitting-drivers.rst} | 8 +-
Documentation/process/submitting-patches.rst | 840 +++++++++++++++
.../volatile-considered-harmful.rst} | 19 +-
Documentation/rfkill.txt | 2 +-
Documentation/scsi/scsi-parameters.txt | 2 +-
Documentation/scsi/scsi_mid_low_api.txt | 2 +-
Documentation/scsi/sym53c8xx_2.txt | 2 +-
Documentation/sound/alsa/alsa-parameters.txt | 2 +-
Documentation/sound/oss/oss-parameters.txt | 2 +-
Documentation/sysctl/kernel.txt | 4 +-
Documentation/sysfs-rules.txt | 184 ----
Documentation/sysrq.txt | 257 -----
Documentation/virtual/kvm/review-checklist.txt | 4 +-
Documentation/vm/numa | 2 +-
.../watchdog/convert_drivers_to_kernel_api.txt | 2 +-
Documentation/watchdog/watchdog-parameters.txt | 2 +-
Documentation/x86/boot.txt | 2 +-
Documentation/zh_CN/CodingStyle | 6 +-
Documentation/zh_CN/HOWTO | 30 +-
Documentation/zh_CN/SecurityBugs | 6 +-
Documentation/zh_CN/SubmittingDrivers | 12 +-
Documentation/zh_CN/SubmittingPatches | 14 +-
Documentation/zh_CN/arm/Booting | 2 +-
Documentation/zh_CN/email-clients.txt | 4 +-
Documentation/zh_CN/oops-tracing.txt | 6 +-
Documentation/zh_CN/stable_api_nonsense.txt | 4 +-
Documentation/zh_CN/stable_kernel_rules.txt | 6 +-
.../zh_CN/volatile-considered-harmful.txt | 4 +-
MAINTAINERS | 10 +-
README | 408 +-------
arch/x86/Kconfig | 2 +-
drivers/acpi/Kconfig | 2 +-
drivers/ata/libata-core.c | 2 +-
drivers/char/pcmcia/cm4000_cs.c | 4 +-
drivers/net/can/grcan.c | 2 +-
drivers/nvdimm/Kconfig | 2 +-
drivers/staging/vme/devices/vme_user.c | 2 +-
drivers/video/fbdev/skeletonfb.c | 8 +-
drivers/virtio/Kconfig | 2 +-
fs/Kconfig.binfmt | 4 +-
fs/pstore/Kconfig | 2 +-
include/linux/device.h | 2 +-
include/linux/pm.h | 2 +-
include/uapi/linux/major.h | 2 +-
init/Kconfig | 2 +-
init/main.c | 2 +-
lib/Kconfig.debug | 2 +-
scripts/checkpatch.pl | 6 +-
tools/testing/selftests/futex/README | 2 +-
149 files changed, 6041 insertions(+), 5539 deletions(-)
delete mode 100644 Documentation/VGA-softcursor.txt
create mode 100644 Documentation/admin-guide/README.rst
rename Documentation/{bad_memory.txt => admin-guide/bad-memory.rst} (67%)
create mode 100644 Documentation/admin-guide/basic-profiling.rst
create mode 100644 Documentation/admin-guide/binfmt-misc.rst
create mode 100644 Documentation/admin-guide/braille-console.rst
rename Documentation/{BUG-HUNTING => admin-guide/bug-hunting.rst} (66%)
create mode 100644 Documentation/admin-guide/conf.py
rename Documentation/{devices.txt => admin-guide/devices.rst} (79%)
create mode 100644 Documentation/admin-guide/dynamic-debug-howto.rst
create mode 100644 Documentation/admin-guide/index.rst
rename Documentation/{init.txt => admin-guide/init.rst} (65%)
rename Documentation/{initrd.txt => admin-guide/initrd.rst} (70%)
rename Documentation/{java.txt => admin-guide/java.rst} (68%)
rename Documentation/{kernel-parameters.txt =>
admin-guide/kernel-parameters.rst} (99%)
rename Documentation/{md.txt => admin-guide/md.rst} (60%)
rename Documentation/{module-signing.txt => admin-guide/module-signing.rst}
(71%)
rename Documentation/{mono.txt => admin-guide/mono.rst} (61%)
rename Documentation/{oops-tracing.txt => admin-guide/oops-tracing.rst} (52%)
create mode 100644 Documentation/admin-guide/parport.rst
rename Documentation/{ramoops.txt => admin-guide/ramoops.rst} (70%)
rename REPORTING-BUGS => Documentation/admin-guide/reporting-bugs.rst (78%)
rename Documentation/{SecurityBugs => admin-guide/security-bugs.rst} (91%)
rename Documentation/{serial-console.txt => admin-guide/serial-console.rst}
(60%)
create mode 100644 Documentation/admin-guide/sysfs-rules.rst
create mode 100644 Documentation/admin-guide/sysrq.rst
rename Documentation/{unicode.txt => admin-guide/unicode.rst} (89%)
create mode 100644 Documentation/admin-guide/vga-softcursor.rst
delete mode 100644 Documentation/basic_profiling.txt
delete mode 100644 Documentation/binfmt_misc.txt
delete mode 100644 Documentation/braille-console.txt
delete mode 100644 Documentation/development-process/index.rst
delete mode 100644 Documentation/dynamic-debug-howto.txt
delete mode 100644 Documentation/magic-number.txt
delete mode 100644 Documentation/parport.txt
rename Documentation/{development-process => process}/1.Intro.rst (100%)
rename Documentation/{development-process => process}/2.Process.rst (100%)
rename Documentation/{development-process => process}/3.Early-stage.rst (100%)
rename Documentation/{development-process => process}/4.Coding.rst (99%)
rename Documentation/{development-process => process}/5.Posting.rst (96%)
rename Documentation/{development-process => process}/6.Followthrough.rst
(100%)
rename Documentation/{development-process => process}/7.AdvancedTopics.rst
(99%)
rename Documentation/{development-process => process}/8.Conclusion.rst (94%)
rename Documentation/{adding-syscalls.txt => process/adding-syscalls.rst} (65%)
rename Documentation/{applying-patches.txt => process/applying-patches.rst}
(99%)
rename Documentation/{Changes => process/changes.rst} (100%)
rename Documentation/{CodeOfConflict => process/code-of-conflict.rst} (96%)
create mode 100644 Documentation/process/coding-style.rst
rename Documentation/{development-process => process}/conf.py (69%)
rename Documentation/{development-process => process}/development-process.rst
(99%)
rename Documentation/{email-clients.txt => process/email-clients.rst} (100%)
rename Documentation/{HOWTO => process/howto.rst} (96%)
create mode 100644 Documentation/process/index.rst
rename Documentation/{kernel-docs.txt => process/kernel-docs.rst} (100%)
create mode 100644 Documentation/process/magic-number.rst
rename Documentation/{ManagementStyle => process/management-style.rst} (99%)
rename Documentation/{stable_api_nonsense.txt =>
process/stable-api-nonsense.rst} (100%)
rename Documentation/{stable_kernel_rules.txt =>
process/stable-kernel-rules.rst} (97%)
rename Documentation/{SubmitChecklist => process/submit-checklist.rst} (96%)
rename Documentation/{SubmittingDrivers => process/submitting-drivers.rst}
(95%)
create mode 100644 Documentation/process/submitting-patches.rst
rename Documentation/{volatile-considered-harmful.txt =>
process/volatile-considered-harmful.rst} (96%)
delete mode 100644 Documentation/sysfs-rules.txt
delete mode 100644 Documentation/sysrq.txt
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
