Browse Source

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

doc: Fix broken code blocks in coding guidelines
pull/1802/head
Antonio Niño Díaz 6 years ago
committed by GitHub
parent
commit
c3faf745c4
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 3
      docs/coding-guidelines.rst

3
docs/coding-guidelines.rst

@ -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
file names; this type of name reuse should be otherwise avoided.
.. code:: c
#include <string.h>
@ -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.
Example (bl1_fwu.c):
.. code:: c
#include <assert.h>
@ -114,6 +116,7 @@ The ``PLAT_INCLUDES`` variable is used for this purpose. This is needed in
particular for the file ``platform_def.h``.
Example:
.. code:: c
PLAT_INCLUDES += -Iinclude/plat/myplat/include

Loading…
Cancel
Save