linux-kernel - [PATCH 00/17] Improve documentation for the development-process

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 14 Sep 2016 20:05:45 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Markus Heiser <markus.heiser@...marit.de>,
        Jonathan Corbet <corbet@....net>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        LKML <linux-kernel@...r.kernel.org>
Subject: [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%)

-- 
2.7.4