Djam/arm-trusted-firmware
1
0
Fork 0
mirror of https://github.com/ARM-software/arm-trusted-firmware.git synced 2025-05-03 09:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Fix broken code blocks in coding guidelines

Browse source 
Sections 2.2, 2.3 and 2.4 contained example code blocks that were not
being formatted properly due to missing newlines.

Change-Id: I0dbce90c931cf69e4f47d2ccbcc8bc0e20f8fd66
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
This commit is contained in:
Paul Beesley 2019-01-31 11:39:01 +00:00
parent 766ff011ca
commit f8ea0df20b
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/coding-guidelines.rst
View file

@ -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
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
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