[PATCH 00/32] Create an User's manual and improve development-process book

* [PATCH 00/32] Create an User's manual and improve development-process book
@ 2016-10-17 16:55 Mauro Carvalho Chehab
  2016-10-17 16:55 ` [PATCH 01/32] Documentation/applying-patches.txt: fix a bad external link Mauro Carvalho Chehab
                   ` (33 more replies)
  0 siblings, 34 replies; 52+ messages in thread
From: Mauro Carvalho Chehab @ 2016-10-17 16:55 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, LKML

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).

As several of the files that document the user's book and the development
process have a very known name and location, this series opts to keep them
in the same location, adding a symbolic link under Documentation/user and
Documentation/development-process.

The advantage of this approach is that people should not learn that those
files got moved, and sites/git history pointing to those files will still be
pointing to the real thing. The disadvantage is that it is more complex to
see what files were already added to a ReST book and on what book those
files were grouped. 

When compared with the patches I sent to ML before the merge window, I 
removed the patch adding MAINTAINERS to the User's manual, and added 
several other files to both books.

All patches on this series can be found on my development tree:
	https://git.linuxtv.org/mchehab/experimental.git/log/?h=lkml-books

and are all based on Kernel 4.9-rc1.

The Kernel docs html output after this series can be seen at:
	https://mchehab.fedorapeople.org/kernel_docs/

NOTE:
====

In my opinion, it would be better to move the converted files to be inside
a Sphinx build directory, but Jon seems reluctant to that, so, this series
use symlinks, as it is easy to move the files in the future with a very simple
patch, if we decide to do so.

Mauro Carvalho Chehab (32):
  Documentation/applying-patches.txt: fix a bad external link
  REPORTING-BUGS: convert to ReST markup
  README: convert it to ReST markup
  Documentation/kernel-parameters.txt: convert to ReST markup
  docs-rst: add documents to development-process
  docs-rst: create an user's manual book
  Documentation/adding-syscalls.txt: convert it 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/CodeOfConflict: add it to the development-process book
  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/BUG-HUNTING                          |  162 +--
 Documentation/SecurityBugs                         |   12 +-
 Documentation/VGA-softcursor.txt                   |   73 +-
 Documentation/adding-syscalls.txt                  |  263 ++---
 Documentation/applying-patches.txt                 |    2 +-
 Documentation/bad_memory.txt                       |   26 +-
 Documentation/basic_profiling.txt                  |   59 +-
 Documentation/binfmt_misc.txt                      |  134 ++-
 Documentation/braille-console.txt                  |   30 +-
 Documentation/conf.py                              |    2 +
 Documentation/development-process/Changes.rst      |    1 +
 .../development-process/CodeOfConflict.rst         |    1 +
 Documentation/development-process/CodingStyle.rst  |    1 +
 Documentation/development-process/HOWTO.rst        |    1 +
 .../development-process/ManagementStyle.rst        |    1 +
 .../development-process/SubmitChecklist.rst        |    1 +
 .../development-process/SubmittingDrivers.rst      |    1 +
 .../development-process/SubmittingPatches.rst      |    1 +
 .../development-process/adding-syscalls.rst        |    1 +
 .../development-process/applying-patches.rst       |    1 +
 .../development-process/email-clients.rst          |    1 +
 Documentation/development-process/index.rst        |   23 +
 Documentation/development-process/kernel-docs.rst  |    1 +
 Documentation/development-process/magic-number.rst |    1 +
 .../development-process/stable_api_nonsense.rst    |    1 +
 .../development-process/stable_kernel_rules.rst    |    1 +
 .../volatile-considered-harmful.rst                |    1 +
 Documentation/devices.txt                          | 1090 ++++++++++----------
 Documentation/dynamic-debug-howto.txt              |  297 +++---
 Documentation/index.rst                            |    1 +
 Documentation/init.txt                             |   29 +-
 Documentation/initrd.txt                           |  199 ++--
 Documentation/java.txt                             |  244 ++---
 Documentation/kernel-parameters.txt                |   33 +-
 Documentation/magic-number.txt                     |  216 ++--
 Documentation/md.txt                               |  528 ++++++----
 Documentation/module-signing.txt                   |  117 +--
 Documentation/mono.txt                             |   44 +-
 Documentation/oops-tracing.txt                     |  255 ++---
 Documentation/parport.txt                          |  287 +++---
 Documentation/ramoops.txt                          |   86 +-
 Documentation/serial-console.txt                   |   68 +-
 Documentation/sysfs-rules.txt                      |  218 ++--
 Documentation/sysrq.txt                            |  266 ++---
 Documentation/unicode.txt                          |   22 +-
 Documentation/user/BUG-HUNTING.rst                 |    1 +
 Documentation/user/README.rst                      |    1 +
 Documentation/user/REPORTING-BUGS.rst              |    1 +
 Documentation/user/SecurityBugs.rst                |    1 +
 Documentation/user/VGA-softcursor.rst              |    1 +
 Documentation/user/bad_memory.rst                  |    1 +
 Documentation/user/basic_profiling.rst             |    1 +
 Documentation/user/binfmt_misc.rst                 |    1 +
 Documentation/user/braile-console.rst              |    1 +
 Documentation/user/conf.py                         |   10 +
 Documentation/user/devices.rst                     |    1 +
 Documentation/user/dynamic-debug-howto.rst         |    1 +
 Documentation/user/index.rst                       |   34 +
 Documentation/user/init.rst                        |    1 +
 Documentation/user/initrd.rst                      |    1 +
 Documentation/user/java.rst                        |    1 +
 Documentation/user/kernel-parameters.rst           |    1 +
 Documentation/user/md.rst                          |    1 +
 Documentation/user/module-signing.rst              |    1 +
 Documentation/user/mono.rst                        |    1 +
 Documentation/user/oops-tracing.rst                |    1 +
 Documentation/user/parport.rst                     |    1 +
 Documentation/user/ramoops.rst                     |    1 +
 Documentation/user/serial-console.rst              |    1 +
 Documentation/user/sysfs-rules.rst                 |    1 +
 Documentation/user/sysrq.rst                       |    1 +
 Documentation/user/unicode.rst                     |    1 +
 Documentation/volatile-considered-harmful.txt      |   19 +-
 README                                             |  105 +-
 REPORTING-BUGS                                     |   66 +-
 75 files changed, 2791 insertions(+), 2270 deletions(-)
 create mode 120000 Documentation/development-process/Changes.rst
 create mode 120000 Documentation/development-process/CodeOfConflict.rst
 create mode 120000 Documentation/development-process/CodingStyle.rst
 create mode 120000 Documentation/development-process/HOWTO.rst
 create mode 120000 Documentation/development-process/ManagementStyle.rst
 create mode 120000 Documentation/development-process/SubmitChecklist.rst
 create mode 120000 Documentation/development-process/SubmittingDrivers.rst
 create mode 120000 Documentation/development-process/SubmittingPatches.rst
 create mode 120000 Documentation/development-process/adding-syscalls.rst
 create mode 120000 Documentation/development-process/applying-patches.rst
 create mode 120000 Documentation/development-process/email-clients.rst
 create mode 120000 Documentation/development-process/kernel-docs.rst
 create mode 120000 Documentation/development-process/magic-number.rst
 create mode 120000 Documentation/development-process/stable_api_nonsense.rst
 create mode 120000 Documentation/development-process/stable_kernel_rules.rst
 create mode 120000 Documentation/development-process/volatile-considered-harmful.rst
 create mode 120000 Documentation/user/BUG-HUNTING.rst
 create mode 120000 Documentation/user/README.rst
 create mode 120000 Documentation/user/REPORTING-BUGS.rst
 create mode 120000 Documentation/user/SecurityBugs.rst
 create mode 120000 Documentation/user/VGA-softcursor.rst
 create mode 120000 Documentation/user/bad_memory.rst
 create mode 120000 Documentation/user/basic_profiling.rst
 create mode 120000 Documentation/user/binfmt_misc.rst
 create mode 120000 Documentation/user/braile-console.rst
 create mode 100644 Documentation/user/conf.py
 create mode 120000 Documentation/user/devices.rst
 create mode 120000 Documentation/user/dynamic-debug-howto.rst
 create mode 100644 Documentation/user/index.rst
 create mode 120000 Documentation/user/init.rst
 create mode 120000 Documentation/user/initrd.rst
 create mode 120000 Documentation/user/java.rst
 create mode 120000 Documentation/user/kernel-parameters.rst
 create mode 120000 Documentation/user/md.rst
 create mode 120000 Documentation/user/module-signing.rst
 create mode 120000 Documentation/user/mono.rst
 create mode 120000 Documentation/user/oops-tracing.rst
 create mode 120000 Documentation/user/parport.rst
 create mode 120000 Documentation/user/ramoops.rst
 create mode 120000 Documentation/user/serial-console.rst
 create mode 120000 Documentation/user/sysfs-rules.rst
 create mode 120000 Documentation/user/sysrq.rst
 create mode 120000 Documentation/user/unicode.rst

-- 
2.7.4

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