diff mbox series

[06/18] doc: Fix code blocks in v6.3.3 release notes

Message ID 20191209011448.19319-6-oohall@gmail.com
State Accepted
Headers show
Series [01/18] doc: Add skiboot-5.2.0 ref | expand

Checks

Context Check Description
snowpatch_ozlabs/apply_patch fail Failed to apply to any branch
snowpatch_ozlabs/apply_patch warning Failed to apply on branch master (d75e82dbfbb9443efeb3f9a5921ac23605aab469)

Commit Message

Oliver O'Halloran Dec. 9, 2019, 1:14 a.m. UTC
Sphinx seems to choke if there's an additional indentation in a ::
block.

e.g.:

::
   one
   two
    three
   four

It'll complain about the indentation changing at three. A
".. code-block:: text" block doesn't seem to have this problem so use
that instead. Also note that you need a blank line between the
code-block and the start of the actual code block.

Signed-off-by: Oliver O'Halloran <oohall@gmail.com>
---
 doc/release-notes/skiboot-6.3.3.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/doc/release-notes/skiboot-6.3.3.rst b/doc/release-notes/skiboot-6.3.3.rst
index c2d21a1f7c33..f27d38f81df0 100644
--- a/doc/release-notes/skiboot-6.3.3.rst
+++ b/doc/release-notes/skiboot-6.3.3.rst
@@ -17,7 +17,8 @@  Bug fixes included in this release are:
   Only the reg member is sent anywhere (via xscom_write), so the structure
   does not need to be packed.
 
-::
+.. code-block:: text
+
   Fixes GCC9 build problem:
   hw/sbe-p9.c: In function ‘p9_sbe_msg_send’:
   hw/sbe-p9.c:270:9: error: taking address of packed member of ‘struct p9_sbe_msg’ may result in an unaligned p
@@ -28,7 +29,8 @@  Bug fixes included in this release are:
 - hdata/vpd: fix printing (char*)0x00
   GCC9 now catches this bug:
 
-::
+.. code-block:: text
+
   In file included from hdata/vpd.c:17:
   In function ‘vpd_vini_parse’,
       inlined from ‘vpd_data_parse’ at hdata/vpd.c:416:3:
@@ -46,7 +48,8 @@  Bug fixes included in this release are:
 
 - errorlog: Prevent alignment error building with gcc9.
 
-::
+.. code-block:: text
+
   Fixes this build error:
   [ 52s] hw/fsp/fsp-elog-write.c: In function 'opal_elog_read':
   [ 52s] hw/fsp/fsp-elog-write.c:213:12: error: taking address of packed member of 'struct errorlog' may result