Skip to content

Improve documentation for the development-process

Mauro Carvalho Chehab linux-hwmon lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest17 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/17HOWTO.rst: update information about generating documentationDocumentation/development-process/HOWTO.rst+22 -60 replies
2/17HOWTO.rst: improve some markups to make it visually betterDocumentation/development-process/HOWTO.rst+16 -200 replies
3/17HOWTO.rst: adjust external link referencesDocumentation/development-process/HOWTO.rst+17 -200 replies
4/17Changes.rst: add minimal requirements for documentation buildDocumentation/development-process/Changes.rst+35 -10 replies
5/17SubmitChecklist: update kernel-doc taskDocumentation/SubmitChecklist Documentation/kernel-documentation.rst+6 -30 replies
6/17SubmitChecklist: convert it to ReST markupDocumentation/SubmitChecklist+63 -550 replies
7/17SubmitChecklist: rename to RST and add to the development-proccess bookDocumentation/development-process/SubmitChecklist.rst Documentation/development-process/index.rst Documentation/hwmon/submitting-patches +3 more+7 -61 reply
8/17doc-rst: add CSS styles for :kbd: and :menuselection:Documentation/sphinx-static/theme_overrides.css+14 -10 replies
9/17email-clients.txt: convert it to ReST markupDocumentation/development-process/5.Posting.rst Documentation/development-process/SubmittingPatches.rst Documentation/email-clients.txt +2 more+127 -970 replies
10/17email-clients.txt: add it to the development-process bookDocumentation/development-process/email-clients.rst Documentation/development-process/index.rst+1 -00 replies
11/17SubmittingPatches.rst: Add some cross-referencesDocumentation/development-process/SubmitChecklist.rst Documentation/development-process/SubmittingPatches.rst Documentation/development-process/development-process.rst +1 more+21 -90 replies
12/17SubmittingPatches.rst: enrich the Sphinx outputDocumentation/development-process/SubmittingPatches.rst+55 -450 replies
13/17SubmittingDrivers.rst: add a cross reference to CodingStyleDocumentation/development-process/SubmittingDrivers.rst+4 -30 replies
14/17stable_api_nonsense.rst: fix emphasis on SphinxDocumentation/development-process/stable_api_nonsense.rst+1 -10 replies
15/17ManagementStyle.rst: avoid emphasis where not desiredDocumentation/development-process/ManagementStyle.rst+2 -00 replies
16/17stable_kernel_rules.rst: Add cross-references to other ReST filesDocumentation/development-process/stable_kernel_rules.rst+5 -20 replies
17/17applying-patches.rst: Update the information thereDocumentation/development-process/applying-patches.rst+110 -1450 replies

Reviews trailers per patch

1 of 17 patches has a Reviewed-by or Acked-by.

PatchJean Delvare
1/17
2/17
3/17
4/17
5/17
6/17
7/17R-b
8/17
9/17
10/17
11/17
12/17
13/17
14/17
15/17
16/17
17/17

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 00/17] Improve documentation for the development-process

This patch series is a followup to be applied after the:
[PATCH v3 00/21] Create a book for Kernel development

patch series.

It addresses some issues I noticed after re-reading the html docs after the conversion of those files to ReST.

It also converts two extra documents to ReST:
Documentation/SubmitChecklist
Documentation/email-clients.txt

Both are mentioned on the previous document, and are part of the patch submission process. So, it makes sense to group them at the development-process book.

I also took the time to update the applying-patches.rst, as I found some outdated information there.

Regards,
Mauro

Mauro Carvalho Chehab (17):
HOWTO.rst: update information about generating documentation HOWTO.rst: improve some markups to make it visually better HOWTO.rst: adjust external link references
Changes.rst: add minimal requirements for documentation build
SubmitChecklist: update kernel-doc task
SubmitChecklist: convert it to ReST markup
SubmitChecklist: rename to RST and add to the development-proccess
book
doc-rst: add CSS styles for :kbd: and :menuselection:
email-clients.txt: convert it to ReST markup email-clients.txt: add it to the development-process book SubmittingPatches.rst: Add some cross-references SubmittingPatches.rst: enrich the Sphinx output SubmittingDrivers.rst: add a cross reference to CodingStyle stable_api_nonsense.rst: fix emphasis on Sphinx ManagementStyle.rst: avoid emphasis where not desired stable_kernel_rules.rst: Add cross-references to other ReST files applying-patches.rst: Update the information there

 Documentation/SubmitChecklist                      | 109 ---------
 Documentation/development-process/5.Posting.rst    |   2 +-
 Documentation/development-process/Changes.rst      |  36 ++-
 Documentation/development-process/HOWTO.rst        | 101 ++++----
 .../development-process/ManagementStyle.rst        |   2 +
 .../development-process/SubmitChecklist.rst        | 120 ++++++++++
 .../development-process/SubmittingDrivers.rst      |   7 +-
 .../development-process/SubmittingPatches.rst      | 124 +++++-----
 .../development-process/applying-patches.rst       | 255 +++++++++------------
 .../development-process/development-process.rst    |   2 +
 .../email-clients.rst}                             | 216 +++++++++--------
 Documentation/development-process/index.rst        |   2 +
 .../development-process/stable_api_nonsense.rst    |   2 +-
 .../development-process/stable_kernel_rules.rst    |   7 +-
 Documentation/hwmon/submitting-patches             |   2 +-
 Documentation/ja_JP/SubmitChecklist                |   4 +-
 Documentation/ja_JP/SubmittingPatches              |   4 +-
 Documentation/kernel-documentation.rst             |   2 +
 Documentation/sphinx-static/theme_overrides.css    |  15 +-
 Documentation/zh_CN/SubmittingPatches              |   2 +-
 Documentation/zh_CN/email-clients.txt              |   4 +-
 21 files changed, 555 insertions(+), 463 deletions(-)
 delete mode 100644 Documentation/SubmitChecklist
 create mode 100644 Documentation/development-process/SubmitChecklist.rst
 rename Documentation/{email-clients.txt => development-process/email-clients.rst} (56%)
Signature · 1 line
2.7.4