There are several documents related to Kernel development, where the
HOWTO working like an index to most of them.
Convert the documents mentioned at HOWTO (including it) 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
Mauro Carvalho Chehab (17):
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
docs-rst: build stuff at kernel-development on Sphinx
Documentation/index.rst | 1 +
.../{Changes => kernel-development/Changes.rst} | 226 +++---
.../CodingStyle.rst} | 384 ++++++----
.../{HOWTO => kernel-development/HOWTO.rst} | 69 +-
.../ManagementStyle.rst} | 152 ++--
.../SecurityBugs.rst} | 14 +-
.../SubmittingDrivers.rst} | 47 +-
.../SubmittingPatches.rst} | 234 +++---
.../applying-patches.rst} | 312 ++++----
Documentation/kernel-development/index.rst | 29 +
Documentation/kernel-development/kernel-docs.rst | 791 +++++++++++++++++++++
.../stable_api_nonsense.rst} | 35 +-
.../stable_kernel_rules.rst} | 103 ++-
Documentation/kernel-docs.txt | 731 -------------------
14 files changed, 1813 insertions(+), 1315 deletions(-)
rename Documentation/{Changes => kernel-development/Changes.rst} (56%)
rename Documentation/{CodingStyle => kernel-development/CodingStyle.rst} (78%)
rename Documentation/{HOWTO => kernel-development/HOWTO.rst} (97%)
rename Documentation/{ManagementStyle => kernel-development/ManagementStyle.rst} (76%)
rename Documentation/{SecurityBugs => kernel-development/SecurityBugs.rst} (92%)
rename Documentation/{SubmittingDrivers => kernel-development/SubmittingDrivers.rst} (85%)
rename Documentation/{SubmittingPatches => kernel-development/SubmittingPatches.rst} (86%)
rename Documentation/{applying-patches.txt => kernel-development/applying-patches.rst} (68%)
create mode 100644 Documentation/kernel-development/index.rst
create mode 100644 Documentation/kernel-development/kernel-docs.rst
rename Documentation/{stable_api_nonsense.txt => kernel-development/stable_api_nonsense.rst} (92%)
rename Documentation/{stable_kernel_rules.txt => kernel-development/stable_kernel_rules.rst} (67%)
delete mode 100644 Documentation/kernel-docs.txt
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
