aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSandrine Bailleux <sandrine.bailleux@arm.com>2020-08-21 12:14:51 +0000
committerTrustedFirmware Code Review <review@review.trustedfirmware.org>2020-08-21 12:14:51 +0000
commit768f83310e168ba0f5feee856459c47ceb250a04 (patch)
treea35d1799ac0cc58f58bea93cbd27b714dcfe6fe6 /docs
parent1566bc3e53837eb40b7027e20c0bc352be52626d (diff)
parent9061c0c9ab70bea29a56f1ea73f8f0f8859f0bab (diff)
downloadtrusted-firmware-a-768f83310e168ba0f5feee856459c47ceb250a04.tar.gz
Merge "doc: Minor formatting improvement in the coding guidelines document" into integration
Diffstat (limited to 'docs')
-rw-r--r--docs/process/coding-guidelines.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/process/coding-guidelines.rst b/docs/process/coding-guidelines.rst
index f7d53a97eb..97086047d0 100644
--- a/docs/process/coding-guidelines.rst
+++ b/docs/process/coding-guidelines.rst
@@ -95,10 +95,13 @@ By default, all logging statements with a log level ``<= LOG_LEVEL_INFO`` will
be compiled into debug builds and all statements with a log level
``<= LOG_LEVEL_NOTICE`` will be compiled into release builds. This can be
overridden from the command line or by the platform makefile (although it may be
-necessary to clean the build directory first). For example, to enable
-``VERBOSE`` logging on FVP:
+necessary to clean the build directory first).
-``make PLAT=fvp LOG_LEVEL=50 all``
+For example, to enable ``VERBOSE`` logging on FVP:
+
+.. code:: shell
+
+ make PLAT=fvp LOG_LEVEL=50 all
Use const data where possible
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^