diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-19 07:07:47 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-09-20 20:37:01 -0400 |
commit | 3772ec4adfcd5b2ce8829c4a5fbd24411aa67e68 (patch) | |
tree | 06537ae3c98dc504575916ad052241b289697a64 | |
parent | 5d628b4527e40002b2eea83a13a5191113767d46 (diff) |
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/CodingStyle | 14 |
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: | |||
333 | Example: ``pte_t`` etc. opaque objects that you can only access using | 333 | Example: ``pte_t`` etc. opaque objects that you can only access using |
334 | the proper accessor functions. | 334 | the proper accessor functions. |
335 | 335 | ||
336 | NOTE! Opaqueness and ``accessor functions`` are not good in themselves. | 336 | .. note:: |
337 | The reason we have them for things like pte_t etc. is that there | 337 | |
338 | really is absolutely **zero** portably accessible information there. | 338 | Opaqueness and ``accessor functions`` are not good in themselves. |
339 | The reason we have them for things like pte_t etc. is that there | ||
340 | really is absolutely **zero** portably accessible information there. | ||
339 | 341 | ||
340 | (b) Clear integer types, where the abstraction **helps** avoid confusion | 342 | (b) Clear integer types, where the abstraction **helps** avoid confusion |
341 | whether it is ``int`` or ``long``. | 343 | whether it is ``int`` or ``long``. |
@@ -343,8 +345,10 @@ useful only for: | |||
343 | u8/u16/u32 are perfectly fine typedefs, although they fit into | 345 | u8/u16/u32 are perfectly fine typedefs, although they fit into |
344 | category (d) better than here. | 346 | category (d) better than here. |
345 | 347 | ||
346 | NOTE! Again - there needs to be a **reason** for this. If something is | 348 | .. note:: |
347 | ``unsigned long``, then there's no reason to do | 349 | |
350 | Again - there needs to be a **reason** for this. If something is | ||
351 | ``unsigned long``, then there's no reason to do | ||
348 | 352 | ||
349 | typedef unsigned long myflags_t; | 353 | typedef unsigned long myflags_t; |
350 | 354 | ||