Skip to content

Commit

Permalink
doc: Fix code blocks in v6.3.3 release notes
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
oohal committed Dec 16, 2019
1 parent 28eab7c commit 93ea477
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/release-notes/skiboot-6.3.3.rst
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit 93ea477

Please sign in to comment.