Documentation/CodingStyle: use the .. note:: markup where needed
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 19 Sep 2016 11:07:47 +0000 (08:07 -0300)
committerJonathan Corbet <corbet@lwn.net>
Wed, 21 Sep 2016 00:37:01 +0000 (18:37 -0600)
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/CodingStyle

index 0024c36b804615d92ffa5586ddd5e64f185ec7d4..7e30da38bb3ac958a0954a2bede5e889103aad28 100644 (file)
@@ -333,9 +333,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``.
@@ -343,8 +345,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;