diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-01-31 11:39:01 +0000 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-01-31 11:39:29 +0000 |
| commit | f8ea0df20beaa6584a61cfcb9562ea4d897e1aa4 (patch) | |
| tree | 509a9a695614ac1f2689d436cb71f1f37d8b7930 /docs | |
| parent | 766ff011ca2009231d5db7268fa4dd5008c2325a (diff) | |
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 <paul.beesley@arm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/coding-guidelines.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/coding-guidelines.rst b/docs/coding-guidelines.rst index 5a30e91e..d5ac9788 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 <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 |