Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

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

Documentation/CodingStyle

+9 −5
Original line number Diff line number Diff line
@@ -333,7 +333,9 @@ 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.

     .. 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.
@@ -343,7 +345,9 @@ 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

     .. 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;