From f8ea0df20beaa6584a61cfcb9562ea4d897e1aa4 Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Thu, 31 Jan 2019 11:39:01 +0000 Subject: [PATCH] doc: Fix broken code blocks in coding guidelines 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 --- docs/coding-guidelines.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/coding-guidelines.rst b/docs/coding-guidelines.rst index 5a30e91e2..d5ac97882 100644 --- a/docs/coding-guidelines.rst +++ b/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 @@ -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 @@ -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