Commit 3772ec4a authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 5d628b45
...@@ -333,7 +333,9 @@ useful only for: ...@@ -333,7 +333,9 @@ useful only for:
Example: ``pte_t`` etc. opaque objects that you can only access using Example: ``pte_t`` etc. opaque objects that you can only access using
the proper accessor functions. the proper accessor functions.
NOTE! Opaqueness and ``accessor functions`` are not good in themselves. .. note::
Opaqueness and ``accessor functions`` are not good in themselves.
The reason we have them for things like pte_t etc. is that there The reason we have them for things like pte_t etc. is that there
really is absolutely **zero** portably accessible information there. really is absolutely **zero** portably accessible information there.
...@@ -343,7 +345,9 @@ useful only for: ...@@ -343,7 +345,9 @@ useful only for:
u8/u16/u32 are perfectly fine typedefs, although they fit into u8/u16/u32 are perfectly fine typedefs, although they fit into
category (d) better than here. category (d) better than here.
NOTE! Again - there needs to be a **reason** for this. If something is .. note::
Again - there needs to be a **reason** for this. If something is
``unsigned long``, then there's no reason to do ``unsigned long``, then there's no reason to do
typedef unsigned long myflags_t; typedef unsigned long myflags_t;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment