Unverified Commit c3faf745 authored by Antonio Niño Díaz's avatar Antonio Niño Díaz Committed by GitHub
Browse files

Merge pull request #1798 from pbeesley-arm/pb/fix-code-style

doc: Fix broken code blocks in coding guidelines
parents 766ff011 f8ea0df2
...@@ -72,6 +72,7 @@ Groups must be separated by a single blank line for clarity. ...@@ -72,6 +72,7 @@ Groups must be separated by a single blank line for clarity.
The example below illustrates the ordering rules using some contrived header The example below illustrates the ordering rules using some contrived header
file names; this type of name reuse should be otherwise avoided. file names; this type of name reuse should be otherwise avoided.
.. code:: c .. code:: c
#include <string.h> #include <string.h>
...@@ -98,6 +99,7 @@ For header files that are **not** in the same directory as the source file that ...@@ -98,6 +99,7 @@ For header files that are **not** in the same directory as the source file that
is including them, use the ``<...>`` variant. is including them, use the ``<...>`` variant.
Example (bl1_fwu.c): Example (bl1_fwu.c):
.. code:: c .. code:: c
#include <assert.h> #include <assert.h>
...@@ -114,6 +116,7 @@ The ``PLAT_INCLUDES`` variable is used for this purpose. This is needed in ...@@ -114,6 +116,7 @@ The ``PLAT_INCLUDES`` variable is used for this purpose. This is needed in
particular for the file ``platform_def.h``. particular for the file ``platform_def.h``.
Example: Example:
.. code:: c .. code:: c
PLAT_INCLUDES += -Iinclude/plat/myplat/include PLAT_INCLUDES += -Iinclude/plat/myplat/include
......
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