summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-19 08:07:47 -0300
committerJonathan Corbet <corbet@lwn.net>2016-09-20 18:37:01 -0600
commit3772ec4adfcd5b2ce8829c4a5fbd24411aa67e68 (patch)
tree06537ae3c98dc504575916ad052241b289697a64
parent5d628b4527e40002b2eea83a13a5191113767d46 (diff)
downloadlwn-3772ec4adfcd5b2ce8829c4a5fbd24411aa67e68.tar.gz
lwn-3772ec4adfcd5b2ce8829c4a5fbd24411aa67e68.zip
Documentation/CodingStyle: use the .. note:: markup where needed
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>
-rw-r--r--Documentation/CodingStyle14
1 files changed, 9 insertions, 5 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 0024c36b8046..7e30da38bb3a 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -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;