mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
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 v3 10/21] Documentation/CodingStyle: use the .. note:: markup where needed
Date: Wed, 14 Sep 2016 08:06:39 -0300	[thread overview]
Message-ID: <1b9bfb9df65e5cc2fc43cb014b118d2bc652bb8b.1473849886.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473849886.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473849886.git.mchehab@s-opensource.com>

There are two places there where there are notes that should
be highlighted. So, use the ReST note markup for such texts.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/CodingStyle | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index e669ecdcd8fe..ef5b84417224 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -344,9 +344,11 @@ useful only for:
      Example: ``pte_t`` etc. opaque objects that you can only access using
      the proper accessor functions.
 
-     NOTE! Opaqueness and ``accessor functions`` are not good in themselves.
-     The reason we have them for things like pte_t etc. is that there
-     really is absolutely **zero** portably accessible information there.
+     .. note::
+
+       Opaqueness and ``accessor functions`` are not good in themselves.
+       The reason we have them for things like pte_t etc. is that there
+       really is absolutely **zero** portably accessible information there.
 
  (b) Clear integer types, where the abstraction **helps** avoid confusion
      whether it is ``int`` or ``long``.
@@ -354,8 +356,10 @@ useful only for:
      u8/u16/u32 are perfectly fine typedefs, although they fit into
      category (d) better than here.
 
-     NOTE! Again - there needs to be a **reason** for this. If something is
-     ``unsigned long``, then there's no reason to do
+     .. note::
+
+       Again - there needs to be a **reason** for this. If something is
+       ``unsigned long``, then there's no reason to do
 
 	typedef unsigned long myflags_t;
 
-- 
2.7.4

  parent reply	other threads:[~2016-09-14 11:14 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-14 11:06 [PATCH v3 00/21] Create a book for Kernel development Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 01/21] doc: development-process: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 02/21] doc: development-process: rename files to rst Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 03/21] docs-rst: create a book for the development process Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 04/21] Documentation/HOWTO: convert to ReST notation Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 05/21] Documentation/applying-patches.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-16 17:10   ` Jonathan Corbet
2016-09-16 17:20     ` Joe Perches
2016-09-16 21:36       ` Mauro Carvalho Chehab
2016-09-16 20:25     ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 06/21] Documentation/Changes: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 07/21] Documentation/CodingStyle: Convert " Mauro Carvalho Chehab
2016-09-16 17:13   ` Jonathan Corbet
2016-09-16 20:34     ` Mauro Carvalho Chehab
2016-09-17  9:58       ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 08/21] Documentation/CodingStyle: use the proper tag for verbatim font Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 09/21] Documentation/CodingStyle: replace underline markups Mauro Carvalho Chehab
2016-09-14 11:06 ` Mauro Carvalho Chehab [this message]
2016-09-14 11:06 ` [PATCH v3 11/21] Documentation/kernel-docs.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-16 17:15   ` Jonathan Corbet
2016-09-16 20:42     ` Mauro Carvalho Chehab
2016-09-16 21:00       ` Jonathan Corbet
2016-09-16 21:28         ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 12/21] Documentation/ManagementStyle: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 13/21] Documentation/SecurityBugs: " Mauro Carvalho Chehab
2016-09-16 17:17   ` Jonathan Corbet
2016-09-16 20:53     ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 14/21] Documentation/stable_api_nonsense.txt: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 15/21] Documentation/stable_kernel_rules.txt: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 16/21] Documentation/SubmittingDrivers: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 17/21] Documentation/SubmittingPatches: " Mauro Carvalho Chehab
2016-09-16 17:21   ` Jonathan Corbet
2016-09-16 22:14     ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 18/21] Documentation/HOWTO: add cross-references to other documents Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 19/21] docs-rst: move HOWTO and mentioned documents to development-process/ Mauro Carvalho Chehab
2016-09-16 17:23   ` Jonathan Corbet
2016-09-14 11:06 ` [PATCH v3 21/21] doc-rst: Add the new development-process/ files 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=1b9bfb9df65e5cc2fc43cb014b118d2bc652bb8b.1473849886.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®