Miscellaneous doc fixes/enhancements

Change-Id: I915303cea787d9fb188428b98ac6cfc610cc4470
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

diff --git a/docs/auth-framework.rst b/docs/auth-framework.rst
index e0b569f31b1e7ad0169d203360abe247241f0d6e..a46f946b6f979b58e9dd9addcf8f94473eb17a59 100644 (file)
--- a/docs/auth-framework.rst
+++ b/docs/auth-framework.rst
@@ -720,7 +720,7 @@ Example: the BL31 Chain of Trust
 
 Four image descriptors form the BL31 Chain of Trust:
 
-.. code:: asm
+.. code:: c
 
     [TRUSTED_KEY_CERT_ID] = {
         .img_id = TRUSTED_KEY_CERT_ID,

diff --git a/docs/coding-guidelines.rst b/docs/coding-guidelines.rst
index d5ac978828dc1b41e8966aeb2fa191f977dba09e..e8f365b365b565fa12b8c2fdd70f94f74cec28f8 100644 (file)
--- a/docs/coding-guidelines.rst
+++ b/docs/coding-guidelines.rst
@@ -85,7 +85,7 @@ file names; this type of name reuse should be otherwise avoided.
   #include "./a_header.h"
 
 Include statement variants
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Two variants of the ``#include`` directive are acceptable in the TF codebase.
 Correct use of the two styles improves readability by suggesting the location
@@ -125,7 +125,7 @@ Types and typedefs
 ------------------
 
 Use of built-in *C* and *libc* data types
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The TF codebase should be kept as portable as possible, especially since both
 64-bit and 32-bit platforms are supported. To help with this, the following data
@@ -214,9 +214,8 @@ type usage guidelines should be followed:
             u_register_t arg7;
     } aapcs64_params_t;
 
-
-    If some code wants to operate on ``arg0`` and knows that it represents a
-    32-bit unsigned integer on all systems, cast it to ``unsigned int``.
+If some code wants to operate on ``arg0`` and knows that it represents a 32-bit
+unsigned integer on all systems, cast it to ``unsigned int``.
 
 These guidelines should be updated if additional types are needed.
 

diff --git a/docs/firmware-design.rst b/docs/firmware-design.rst
index 06fdbacdd2f248582ddfc54cbf46b1acd3988150..d00e45c1680263eee52473526b0d49bcafca56cb 100644 (file)
--- a/docs/firmware-design.rst
+++ b/docs/firmware-design.rst
@@ -2343,18 +2343,18 @@ A publisher that wants to publish event ``foo`` would:
 A subscriber that wants to subscribe to event ``foo`` published above would
 implement:
 
-::
+.. code:: c
 
-   void *foo_handler(const void *arg)
-   {
-        void *result;
+    void *foo_handler(const void *arg)
+    {
+         void *result;
 
-        /* Do handling ... */
+         /* Do handling ... */
 
-        return result;
-   }
+         return result;
+    }
 
-   SUBSCRIBE_TO_EVENT(foo, foo_handler);
+    SUBSCRIBE_TO_EVENT(foo, foo_handler);
 
 
 Reclaiming the BL31 initialization code

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 35d44ca3c067dc654ec10b3010e69b3596c5eddf..db3fe156899d8916d125b10b27278b1ee1f22584 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -575,7 +575,7 @@ Common build options
    1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
    wants the timer registers to be saved and restored.
 
-- ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
+-  ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
    for the BL image. It can be either 0 (include) or 1 (remove). The default
    value is 0.