linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj38.park@gmail.com>
To: corbet@lwn.net, minchan@kernel.org
Cc: mchehab@s-opensource.com, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, SeongJae Park <sj38.park@gmail.com>
Subject: [PATCH v2 01/12] Documentation/process/howto: Mark subsection in suggested format
Date: Tue,  1 Nov 2016 05:27:10 +0900	[thread overview]
Message-ID: <20161031202721.8068-2-sj38.park@gmail.com> (raw)
In-Reply-To: <20161031202721.8068-1-sj38.park@gmail.com>

`Specific guidelines for the kernel documentation` section of
`kernel-documentation.rst` suggests to use ``~`` for subsection but
subsections in HOWTO is not marked in the format.  This commit marks
them in the format.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 Documentation/process/howto.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
index 3f66a1980726..449ca1f199f4 100644
--- a/Documentation/process/howto.rst
+++ b/Documentation/process/howto.rst
@@ -254,7 +254,8 @@ branches.  These different branches are:
   - the 4.x -next kernel tree for integration tests
 
 4.x kernel tree
------------------
+~~~~~~~~~~~~~~~
+
 4.x kernels are maintained by Linus Torvalds, and can be found on
 https://kernel.org in the pub/linux/kernel/v4.x/ directory.  Its development
 process is as follows:
@@ -289,7 +290,8 @@ mailing list about kernel releases:
 	preconceived timeline."*
 
 4.x.y -stable kernel tree
--------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Kernels with 3-part versions are -stable kernels. They contain
 relatively small and critical fixes for security problems or significant
 regressions discovered in a given 4.x kernel.
@@ -312,7 +314,8 @@ documents what kinds of changes are acceptable for the -stable tree, and
 how the release process works.
 
 4.x -git patches
-----------------
+~~~~~~~~~~~~~~~~
+
 These are daily snapshots of Linus' kernel tree which are managed in a
 git repository (hence the name.) These patches are usually released
 daily and represent the current state of Linus' tree.  They are more
@@ -320,7 +323,8 @@ experimental than -rc kernels since they are generated automatically
 without even a cursory glance to see if they are sane.
 
 Subsystem Specific kernel trees and patches
--------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 The maintainers of the various kernel subsystems --- and also many
 kernel subsystem developers --- expose their current state of
 development in source repositories.  That way, others can see what is
@@ -344,7 +348,8 @@ accepted, or rejected.  Most of these patchwork sites are listed at
 https://patchwork.kernel.org/.
 
 4.x -next kernel tree for integration tests
--------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Before updates from subsystem trees are merged into the mainline 4.x
 tree, they need to be integration-tested.  For this purpose, a special
 testing repository exists into which virtually all subsystem trees are
-- 
2.10.0

  reply	other threads:[~2016-10-31 20:27 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-31 20:27 [PATCH v2 00/12] Fix and update HOWTO Korean translation SeongJae Park
2016-10-31 20:27 ` SeongJae Park [this message]
2016-10-31 20:27 ` [PATCH v2 02/12] ko_KR/HOWTO: Fix a typo: s/Linux Torvalds/Linus Torvalds SeongJae Park
2016-10-31 20:27 ` [PATCH v2 03/12] ko_KR/HOWTO: Fix subtitles style SeongJae Park
2016-10-31 20:27 ` [PATCH v2 04/12] ko_KR/HOWTO: Update obsolete link to bugzilla faq SeongJae Park
2016-10-31 20:27 ` [PATCH v2 05/12] ko_KR/HOWTO: Convert to ReST notation SeongJae Park
2016-10-31 20:27 ` [PATCH v2 06/12] ko_KR/HOWTO: Add cross-references to other documents SeongJae Park
2016-10-31 20:27 ` [PATCH v2 07/12] ko_KR/HOWTO: Update information about generating documentation SeongJae Park
2016-10-31 20:27 ` [PATCH v2 08/12] ko_KR/HOWTO: Improve some markups to make it visually better SeongJae Park
2016-10-31 20:27 ` [PATCH v2 09/12] ko_KR/HOWTO: Adjust external link references SeongJae Park
2016-10-31 20:27 ` [PATCH v2 10/12] ko_KR/HOWTO: Clean up bare :: lines SeongJae Park
2016-10-31 20:27 ` [PATCH v2 11/12] ko_KR/HOWTO: Add whitespace between URL and text SeongJae Park
2016-10-31 20:27 ` [PATCH v2 12/12] ko_KR/HOWTO: Mark subsection in suggested format SeongJae Park
2016-11-06 18:21 ` [PATCH v2 00/12] Fix and update HOWTO Korean translation SeongJae Park
2016-11-06 20:45   ` Jonathan Corbet
2016-11-08  0:05 ` Jonathan Corbet
2016-11-08  1:30   ` SeongJae Park

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=20161031202721.8068-2-sj38.park@gmail.com \
    --to=sj38.park@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@s-opensource.com \
    --cc=minchan@kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).