From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Markus Heiser <markus.heiser@darmarit.de>,
Jonathan Corbet <corbet@lwn.net>,
Jani Nikula <jani.nikula@linux.intel.com>,
LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH v2 00/20] Create a book for Kernel development
Date: Mon, 12 Sep 2016 23:17:51 -0300 [thread overview]
Message-ID: <cover.1473732263.git.mchehab@s-opensource.com> (raw)
There are several documents related to Kernel development, where the
HOWTO working like an index to most of them. There are also a series
of files describing the development process.
Convert the documents mentioned at the HOWTO (including it) and the
development-process/ documents to ReST and add them at the Sphinx build.
NOTE: HOWTO also mentions the /README document on it. While IMHO it
makes sense to convert it to ReST, moving it out of the main directory
didn't sound a good idea. So, I'm leaving this one untouched.
PS.: I decided to do such conversion because today I received yet
another email from one developer wanted to submit drivers, but not being
aware of the right proceures. As usual, I pointed him to the Kernel
sources, but there are a way too much documentation there with a mix of
procedures and API docs inside.
It would be a way easier to point to a single URL where the submission
procedures would be altoghether. Hopefully, this will have a lot of time
in the future. My evil plan is to put this doc somewhere at LinuxTV and
have a standard e-mail prepared for such next requests :-D
The produced output, in HTML, is at:
https://mchehab.fedorapeople.org/development-process/
The LaTeX version at:
https://mchehab.fedorapeople.org/development-process/latex/development-process.tex
And the PDF version at:
https://mchehab.fedorapeople.org/development-process/latex/development-process.pdf
--
Version 2 changes:
- On version 1, I forgot to c/c LKML;
- Per Jonathan Corbet's suggestion, this version is placing all documents at
the already existing developing-process/ directory, instead of creating a
new dir;
- Also per Jon's suggestion, it also converts the development-process files
to rst.
- Replaced all occurrences of the renamed files at the Kernel Documentation dir;
- Added conf.py and the need logic to produce both LaTeX and PDF output;
Mauro Carvalho Chehab (20):
docs-rst: move HOWTO and mentioned documents to a separate dir
docs-rst: HOWTO.rst: convert to ReST notation
docs-rst: applying-patches.rst: convert it to ReST markup
docs-rst: Changes.rst: convert it to ReST markup
docs-rst: CodingStyle.rst: Convert to ReST markup
CodingStyle.rst: use the proper tag for verbatim font
CodingStyle.rst: replace underline markups
CodingStyle.rst: use the .. note:: markup where needed
kernel-docs.rst: convert it to ReST markup
ManagementStyle.rst: convert it to ReST markup
SecurityBugs.rst: convert it to ReST markup
stable_api_nonsense.rst: convert it to ReST markup
stable_kernel_rules.rst: convert it to ReST markup
SubmittingDrivers.rst: convert it to ReST markup
SubmittingPatches.rst: convert it to ReST markup
HOWTO.rst: add cross-references to other documents
doc: development-process: rename files to rst
doc: development-process: convert it to ReST markup
doc: adjust references to development-process
doc: Add the development-process to Sphinx build
Documentation/ABI/README | 2 +-
Documentation/BUG-HUNTING | 2 +-
Documentation/DocBook/kernel-hacking.tmpl | 4 +-
Documentation/SubmitChecklist | 4 +-
Documentation/adding-syscalls.txt | 2 +-
Documentation/conf.py | 2 +
.../development-process/{1.Intro => 1.Intro.rst} | 68 +-
.../{2.Process => 2.Process.rst} | 41 +-
.../{3.Early-stage => 3.Early-stage.rst} | 22 +-
.../development-process/{4.Coding => 4.Coding.rst} | 48 +-
.../{5.Posting => 5.Posting.rst} | 30 +-
.../{6.Followthrough => 6.Followthrough.rst} | 14 +-
.../{7.AdvancedTopics => 7.AdvancedTopics.rst} | 13 +-
.../{8.Conclusion => 8.Conclusion.rst} | 8 +-
.../{Changes => development-process/Changes.rst} | 226 +++---
.../CodingStyle.rst} | 384 ++++++----
.../{HOWTO => development-process/HOWTO.rst} | 73 +-
.../ManagementStyle.rst} | 152 ++--
.../SecurityBugs.rst} | 14 +-
.../SubmittingDrivers.rst} | 51 +-
.../SubmittingPatches.rst} | 244 ++++---
.../applying-patches.rst} | 312 ++++----
Documentation/development-process/conf.py | 10 +
.../development-process/development-process.rst | 27 +
Documentation/development-process/index.rst | 31 +
Documentation/development-process/kernel-docs.rst | 791 +++++++++++++++++++++
.../stable_api_nonsense.rst} | 35 +-
.../stable_kernel_rules.rst} | 107 ++-
.../devicetree/bindings/submitting-patches.txt | 2 +-
Documentation/filesystems/locks.txt | 2 +-
Documentation/hwmon/submitting-patches | 6 +-
Documentation/index.rst | 1 +
Documentation/isdn/README | 2 +-
Documentation/ja_JP/HOWTO | 28 +-
Documentation/ja_JP/SubmitChecklist | 2 +-
Documentation/ja_JP/SubmittingPatches | 14 +-
Documentation/ja_JP/stable_api_nonsense.txt | 4 +-
Documentation/ja_JP/stable_kernel_rules.txt | 6 +-
Documentation/kernel-docs.txt | 731 -------------------
Documentation/ko_KR/HOWTO | 28 +-
Documentation/ko_KR/stable_api_nonsense.txt | 4 +-
Documentation/networking/PLIP.txt | 2 +-
Documentation/networking/netdev-FAQ.txt | 8 +-
Documentation/scsi/scsi_mid_low_api.txt | 2 +-
Documentation/virtual/kvm/review-checklist.txt | 4 +-
.../watchdog/convert_drivers_to_kernel_api.txt | 2 +-
Documentation/zh_CN/CodingStyle | 4 +-
Documentation/zh_CN/HOWTO | 28 +-
Documentation/zh_CN/SecurityBugs | 4 +-
Documentation/zh_CN/SubmittingDrivers | 8 +-
Documentation/zh_CN/SubmittingPatches | 10 +-
Documentation/zh_CN/stable_api_nonsense.txt | 4 +-
Documentation/zh_CN/stable_kernel_rules.txt | 6 +-
MAINTAINERS | 2 +-
README | 4 +-
REPORTING-BUGS | 2 +-
drivers/net/ppp/Kconfig | 2 +-
drivers/pcmcia/Kconfig | 2 +-
fs/Kconfig.binfmt | 2 +-
fs/fuse/Kconfig | 2 +-
net/Kconfig | 4 +-
scripts/ver_linux | 2 +-
tools/testing/selftests/futex/README | 2 +-
63 files changed, 2129 insertions(+), 1524 deletions(-)
rename Documentation/development-process/{1.Intro => 1.Intro.rst} (87%)
rename Documentation/development-process/{2.Process => 2.Process.rst} (96%)
rename Documentation/development-process/{3.Early-stage => 3.Early-stage.rst} (97%)
rename Documentation/development-process/{4.Coding => 4.Coding.rst} (97%)
rename Documentation/development-process/{5.Posting => 5.Posting.rst} (96%)
rename Documentation/development-process/{6.Followthrough => 6.Followthrough.rst} (98%)
rename Documentation/development-process/{7.AdvancedTopics => 7.AdvancedTopics.rst} (98%)
rename Documentation/development-process/{8.Conclusion => 8.Conclusion.rst} (96%)
rename Documentation/{Changes => development-process/Changes.rst} (56%)
rename Documentation/{CodingStyle => development-process/CodingStyle.rst} (78%)
rename Documentation/{HOWTO => development-process/HOWTO.rst} (96%)
rename Documentation/{ManagementStyle => development-process/ManagementStyle.rst} (76%)
rename Documentation/{SecurityBugs => development-process/SecurityBugs.rst} (92%)
rename Documentation/{SubmittingDrivers => development-process/SubmittingDrivers.rst} (83%)
rename Documentation/{SubmittingPatches => development-process/SubmittingPatches.rst} (85%)
rename Documentation/{applying-patches.txt => development-process/applying-patches.rst} (68%)
create mode 100644 Documentation/development-process/conf.py
create mode 100644 Documentation/development-process/development-process.rst
create mode 100644 Documentation/development-process/index.rst
create mode 100644 Documentation/development-process/kernel-docs.rst
rename Documentation/{stable_api_nonsense.txt => development-process/stable_api_nonsense.rst} (92%)
rename Documentation/{stable_kernel_rules.txt => development-process/stable_kernel_rules.rst} (65%)
delete mode 100644 Documentation/kernel-docs.txt
--
2.7.4
next reply other threads:[~2016-09-13 2:18 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-13 2:17 Mauro Carvalho Chehab [this message]
2016-09-13 2:17 ` [PATCH v2 01/20] docs-rst: move HOWTO and mentioned documents to a separate dir Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 02/20] docs-rst: HOWTO.rst: convert to ReST notation Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 03/20] docs-rst: applying-patches.rst: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 04/20] docs-rst: Changes.rst: " Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 05/20] docs-rst: CodingStyle.rst: Convert " Mauro Carvalho Chehab
2016-09-13 2:59 ` Joe Perches
2016-09-13 8:46 ` Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 06/20] CodingStyle.rst: use the proper tag for verbatim font Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 07/20] CodingStyle.rst: replace underline markups Mauro Carvalho Chehab
2016-09-13 2:17 ` [PATCH v2 08/20] CodingStyle.rst: use the .. note:: markup where needed Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 09/20] kernel-docs.rst: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 10/20] ManagementStyle.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 11/20] SecurityBugs.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 12/20] stable_api_nonsense.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 13/20] stable_kernel_rules.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 14/20] SubmittingDrivers.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 15/20] SubmittingPatches.rst: " Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 16/20] HOWTO.rst: add cross-references to other documents Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 17/20] doc: development-process: rename files to rst Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 18/20] doc: development-process: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 19/20] doc: adjust references to development-process Mauro Carvalho Chehab
2016-09-13 2:18 ` [PATCH v2 20/20] doc: Add the development-process to Sphinx build Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1473732263.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.