[Skiboot] [RFC PATCH 09/23] doc/release-notes/skiboot-5.1.x: ReStructured Text syntax fixes

Stewart Smith stewart at linux.vnet.ibm.com
Wed Jul 27 17:43:10 AEST 2016


Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
 doc/release-notes/skiboot-5.1.0-beta2.rst |  22 ++++-
 doc/release-notes/skiboot-5.1.0.rst       | 154 +++++++++++++++++++++++++-----
 doc/release-notes/skiboot-5.1.1.rst       |   9 +-
 doc/release-notes/skiboot-5.1.10.rst      |   8 +-
 doc/release-notes/skiboot-5.1.11.rst      |   1 +
 doc/release-notes/skiboot-5.1.12.rst      |  20 +++-
 doc/release-notes/skiboot-5.1.13.rst      |  18 +++-
 doc/release-notes/skiboot-5.1.14.rst      |   1 +
 doc/release-notes/skiboot-5.1.16.rst      |  32 ++++---
 doc/release-notes/skiboot-5.1.17.rst      |   4 +-
 doc/release-notes/skiboot-5.1.2.rst       |  59 +++++++++++-
 doc/release-notes/skiboot-5.1.3.rst       |  63 ++++++++++--
 doc/release-notes/skiboot-5.1.4.rst       |   2 +
 doc/release-notes/skiboot-5.1.5.rst       |  11 ++-
 doc/release-notes/skiboot-5.1.6.rst       |  10 +-
 doc/release-notes/skiboot-5.1.7.rst       |   2 +
 doc/release-notes/skiboot-5.1.9.rst       |   1 +
 17 files changed, 350 insertions(+), 67 deletions(-)

diff --git a/doc/release-notes/skiboot-5.1.0-beta2.rst b/doc/release-notes/skiboot-5.1.0-beta2.rst
index ebd7fc0..9058f95 100644
--- a/doc/release-notes/skiboot-5.1.0-beta2.rst
+++ b/doc/release-notes/skiboot-5.1.0-beta2.rst
@@ -1,5 +1,5 @@
-skiboot-5.1-beta2
------------------
+skiboot-5.1.0-beta2
+===================
 
 skiboot-5.1.0-beta2 was released on August 14th, 2015.
 
@@ -9,7 +9,11 @@ become a new stable release, replacing skiboot-5.0 (released April 14th 2015)
 Skiboot 5.1.0-beta2 contains all fixes from skiboot-5.0 stable branch up to
 skiboot-5.0.5 and everything from 5.1.0-beta1.
 
+New Features
+^^^^^^^^^^^^
+
 Over skiboot-5.1.0-beta1, the following features have been added:
+
 - opal-api: Add OPAL call to handle abnormal reboots.
      OPAL_CEC_REBOOT2
      Currently it will support two reboot types (0). normal reboot, that
@@ -18,27 +22,37 @@ Over skiboot-5.1.0-beta1, the following features have been added:
 
      Long term, this is designed to replace OPAL_CEC_REBOOT.
 
+Bug fixes
+^^^^^^^^^
 Over skiboot-5.1.0-beta1, the following bugs have been fixed:
+
 - external/opal-prd: Only map each PRD range once
+
   - could eventually lead to failing to map PRD ranges
 - On skiboot crash, don't try to print symbol when we didn't find one
+
   - makes backtrace prettier
 - On skiboot crash, dump hssr0 and hsrr1 registers correctly.
 - Better support old and biarch compilers
+
   - test "new" compiler flags before using them
   - Specify -mabi=elfv1 if supported (which means it's needed)
 - fix boot-coverage-report makefile target
 - ipmi: Fix the opal_ipmi_recv() call to handle the error path
+
   - Could make kernel a sad panda when in continues with other IPMI commands
 - IPMI: truncate SELs at 2kb
+
   - it's the limit of the astbmc. We think.
 - IPMI/SEL/PEL:
+
   - As per PEL spec, we should log events with severity >= 0x22 and "service
     action flag" is "on". But in our case, all logs OPAL originagted logs
     are makred as report externally.
     We now only report logs with severity >= 0x22
 - IPMI: fixes to eSEL logging
 - hw/phb3: Change reserved PE to 255
+
   -  Currently, we have reserved PE#0 to which all RIDs are mapped prior
      to PE assignment request from kernel. The last M64 BAR is configured
      to have shared mode. So we have to cut off the first M64 segment,
@@ -47,7 +61,9 @@ Over skiboot-5.1.0-beta1, the following bugs have been fixed:
      have to waste huge M64 space to accommodate the alignment. If we
      have reserved PE#256, the waste of M64 space will be avoided.
 
-Other changes:
+Other changes
+^^^^^^^^^^^^^
 - unified version numbers for bundled utilities
 - external/boot_test/boot_test.sh
+
   - better usable for automated boot testing
diff --git a/doc/release-notes/skiboot-5.1.0.rst b/doc/release-notes/skiboot-5.1.0.rst
index 8558378..d48dc0b 100644
--- a/doc/release-notes/skiboot-5.1.0.rst
+++ b/doc/release-notes/skiboot-5.1.0.rst
@@ -1,5 +1,5 @@
 skiboot-5.1.0
--------------
+=============
 
 skiboot-5.1.0 was released on August 17th, 2015.
 
@@ -11,34 +11,49 @@ Skiboot 5.1.0 contains all fixes from skiboot-5.0 stable branch up to
 skiboot-5.0.5 and everything from 5.1.0-beta1 and 5.1.0-beta2.
 
 Over skiboot-5.1.0-beta2, we have the following changes:
+
 - opal_prd now supports multiple socket systems
 - fix compiler warnings in gard and libflash
 
 Below are the changes introduced in previous skiboot-5.1.0 releases over
 the previous stable release, skiboot-5.0:
 
-New features:
+New features
+^^^^^^^^^^^^
+
 - Add Naples chip (CPU, PHB, LPC serial interrupts) support
 - Added qemu platform
 - improvements to FSI error handling
 - improvements in chip TOD failover (some only on FSP systems)
 - Set Relative Priority Register (RPR) to recommended value
+
   - this affects thread priority in SMT modes
+
 - greatly reduce memory consumption by CPU stacks for non-present CPUs
+
   - Previously we would reserve enough memory for max PIR for each CPU
     type.
   - This fix frees up 77MB of RAM on a typical P8 system.
+
 - increased OPAL API documentation
 - Asynchronous preloading of resources from FSP/flash
+
   - improves boot time on some systems
+
 - Basic Garrison platform support
 - Add Mambo platform (P8 Functional Simulator, systemsim)
+
   - includes fake NVRAM, RTC
+
 - Support building with GCOV, increasing memory for skiboot binary to 2MB
+
   - includes boot code coverage testing
+
 - Increased skiboot HEAP size.
+
   - We are not aware of any system where you would run out, but on large
     systems it was getting closer than we liked.
+
 - add boot_tests.sh for helping automate boot testing on FSP and BMC machines
 - Versioning of pflash and gard utilities to help Linux (or other OS)
   distributions with packaging.
@@ -46,30 +61,37 @@ New features:
 - CAPP timebase sync ("ibm,capp-timebase-sync" in DT to indicate CAPP timebase
   was synced by OPAL)
 - opal-api: Add OPAL call to handle abnormal reboots.
-     OPAL_CEC_REBOOT2
-     Currently it will support two reboot types (0). normal reboot, that
-     will behave similar to that of opal_cec_reboot() call, and
-     (1). platform error reboot.
 
-     Long term, this is designed to replace OPAL_CEC_REBOOT.
+``OPAL_CEC_REBOOT2`` currently supports two reboot types:
+
+   0. normal reboot, that will behave similar to that of opal_cec_reboot() call
+   1. platform error reboot.
 
-New features for FSP based machines:
+Long term, this is designed to replace OPAL_CEC_REBOOT.
+
+New features for FSP based machines
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - in-band IPMI support
 - ethernet adaptor location codes
 - add DIMM frequency information to device tree
 - improvements in FSP error log code paths
 - fix some boot time memory leaks
+
   - harmless to end user
 
-New features for AMI BMC based machines:
+New features for AMI BMC based machines
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - PCIe power workaround for K80
 - Added support for Macronix 128Mbit flash chips
 - Initial PRD support for Firestone platform
 - improved reliability when BMC reboots
 
-The following bugs have been fixed:
+The following bugs have been fixed
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - Increase PHB3 timeout for electrical links coming up to 2 seconds.
+
   - fixes issues with some Mellanox cards
+
 - Hang in opal_reinit_cpus() that could prevent kdump from functioning
 - PHB3: fix crash in phb3_init
 - PHB3: fix crash with fenced PHB in phb3_init_hw()
@@ -77,28 +99,42 @@ The following bugs have been fixed:
   lead to a crash (dereferencing invalid address, deadlock)
 - ipmi/sel: fix use-after-free
 - Bug fixes in EEH handling
-  - opal_pci_next_error() cleared OPAL_EVENT_PCI_ERROR unconditionally, possibly
-    leading to missed errors.
+
+  - opal_pci_next_error() cleared OPAL_EVENT_PCI_ERROR unconditionally,
+    possibly leading to missed errors.
+
 - external/opal-prd: Only map each PRD range once
+
   - could eventually lead to failing to map PRD ranges
+
 - On skiboot crash, don't try to print symbol when we didn't find one
+
   - makes backtrace prettier
+
 - On skiboot crash, dump hssr0 and hsrr1 registers correctly.
 - Better support old and biarch compilers
+
   - test "new" compiler flags before using them
   - Specify -mabi=elfv1 if supported (which means it's needed)
+
 - fix boot-coverage-report makefile target
 - ipmi: Fix the opal_ipmi_recv() call to handle the error path
-  - Could make kernel a sad panda when in continues with other IPMI commands
+
+- Could make kernel a sad panda when in continues with other IPMI commands
 - IPMI: truncate SELs at 2kb
+
   - it's the limit of the astbmc. We think.
+
 - IPMI/SEL/PEL:
+
   - As per PEL spec, we should log events with severity >= 0x22 and "service
     action flag" is "on". But in our case, all logs OPAL originagted logs
     are makred as report externally.
     We now only report logs with severity >= 0x22
+
 - IPMI: fixes to eSEL logging
 - hw/phb3: Change reserved PE to 255
+
   -  Currently, we have reserved PE#0 to which all RIDs are mapped prior
      to PE assignment request from kernel. The last M64 BAR is configured
      to have shared mode. So we have to cut off the first M64 segment,
@@ -107,23 +143,32 @@ The following bugs have been fixed:
      have to waste huge M64 space to accommodate the alignment. If we
      have reserved PE#256, the waste of M64 space will be avoided.
 
-FSP-specific bugs fixed:
+FSP-specific bugs fixed
+^^^^^^^^^^^^^^^^^^^^^^^
 - (also fixed in skiboot-5.0.2) Fix race in firenze_get_slot_info() leading to
   assert() with many PCI cards
-    With many PCI cards, we'd hit a race where calls to
-    firenze_add_pcidev_to_fsp_inventory would step on each other leading to
-    memory corruption and finally an assert() in the allocator being hit
-    during boot.
+
+  With many PCI cards, we'd hit a race where calls to
+  firenze_add_pcidev_to_fsp_inventory would step on each other leading to
+  memory corruption and finally an assert() in the allocator being hit
+  during boot.
+
 - PCIe power workaround for K80 cards
 - /ibm,opal/led renamed to /ibm,opal/leds in Device Tree
+
   - compatible change as no FSP based systems shipped with skiboot-5.0
 
-General improvements:
+General improvements
+^^^^^^^^^^^^^^^^^^^^
 - Preliminary Centaur i2c support
+
   - lays framework for supporting Centaur i2c
+
 - don't run pollers on non-boot CPUs in time_wait
 - improvements to opal-prd, pflash, libflash
+
   - including new blocklevel interface in libflash
+
 - many minor fixes to issues found by static analysis
 - improvements in FSP error log code paths
 - code cleanup in memory allocator
@@ -135,12 +180,17 @@ General improvements:
 - Optimized memset() for POWER8, greatly reducing number of instructions
   executed for boot, which helps boot time in simulators.
 - Major improvements in hello_world kernel
+
   - Bloat of huge 17 instruction test case reduced to 10.
+
 - Disable bust_locks for general calls of abort()
+
   - Should enable better error messages during abort() when other users of
     LPC bus exist (e.g. flash)
+
 - unified version numbers for bundled utilities
 - external/boot_test/boot_test.sh
+
   - better usable for automated boot testing
 
 Contributors
@@ -152,6 +202,10 @@ Processed 372 csets from 27 developers
 A total of 15868 lines added, 3359 removed (delta 12509)
 
 Developers with the most changesets
+
+========================== =============
+Developer                  Changesets
+========================== =============
 Stewart Smith              117 (31.5%)
 Jeremy Kerr                 37 (9.9%)
 Cyril Bur                   33 (8.9%)
@@ -179,12 +233,17 @@ Michael Ellerman             1 (0.3%)
 Andrei Warkentin             1 (0.3%)
 Dan Horák                   1 (0.3%)
 Anton Blanchard              1 (0.3%)
+========================== =============
+
 
 Developers with the most changed lines
-Stewart Smith             4499 (27.3%)
-Benjamin Herrenschmidt    3782 (22.9%)
-Jeremy Kerr               1887 (11.4%)
-Cyril Bur                 1654 (10.0%)
+
+========================== ============
+========================== ============
+Stewart Smith              4499 (27.3%)
+Benjamin Herrenschmidt     3782 (22.9%)
+Jeremy Kerr                1887 (11.4%)
+Cyril Bur                  1654 (10.0%)
 Vasant Hegde               959 (5.8%)
 Mahesh Salgaonkar          886 (5.4%)
 Neelesh Gupta              473 (2.9%)
@@ -194,7 +253,7 @@ Philippe Bergheaud         171 (1.0%)
 Shilpasri G Bhat           165 (1.0%)
 Alistair Popple            151 (0.9%)
 Joel Stanley               105 (0.6%)
-Cédric Le Goater           89 (0.5%)
+Cédric Le Goater            89 (0.5%)
 Gavin Shan                  83 (0.5%)
 Frederic Bonnard            76 (0.5%)
 Kamalesh Babulal            65 (0.4%)
@@ -208,16 +267,28 @@ Hari Bathini                 2 (0.0%)
 Michael Ellerman             1 (0.0%)
 Andrei Warkentin             1 (0.0%)
 Dan Horák                   1 (0.0%)
+========================== ============
 
 Developers with the most lines removed
+
+=========================== ============
+=========================== ============
 Michael Neuling             24 (0.7%)
 Hari Bathini                 1 (0.0%)
+=========================== ============
 
 Developers with the most signoffs (total 253)
-Stewart Smith              249 (98.4%)
+
+=========================== ============
+=========================== ============
+Stewart Smith               249 (98.4%)
 Mahesh Salgaonkar            4 (1.6%)
+=========================== ============
 
 Developers with the most reviews (total 24)
+
+=========================== ============
+=========================== ============
 Vasant Hegde                 9 (37.5%)
 Joel Stanley                 3 (12.5%)
 Gavin Shan                   2 (8.3%)
@@ -228,34 +299,67 @@ Stewart Smith                1 (4.2%)
 Andrei Warkentin             1 (4.2%)
 Preeti U Murthy              1 (4.2%)
 Ananth N Mavinakayanahalli    1 (4.2%)
+=========================== ============
 
 Developers with the most test credits (total 1)
+
+=========================== ============
+=========================== ============
 Chad Larson                  1 (100.0%)
+=========================== ============
 
 Developers who gave the most tested-by credits (total 1)
+
+=========================== ============
+=========================== ============
 Gavin Shan                   1 (100.0%)
+=========================== ============
 
 Developers with the most report credits (total 4)
+
+=========================== ============
+=========================== ============
 Benjamin Herrenschmidt       2 (50.0%)
 Chad Larson                  1 (25.0%)
 Andrei Warkentin             1 (25.0%)
+=========================== ============
 
 Developers who gave the most report credits (total 4)
+
+=========================== ============
+=========================== ============
 Stewart Smith                3 (75.0%)
 Gavin Shan                   1 (25.0%)
+=========================== ============
 
 Top changeset contributors by employer
+
+========================== ============
+========================== ============
 IBM                        369 (99.2%)
 (Unknown)                    3 (0.8%)
+========================== ============
 
 Top lines changed by employer
+
+========================= ==============
+========================= ==============
 IBM                       16497 (100.0%)
 (Unknown)                    3 (0.0%)
+========================= ==============
 
 Employers with the most signoffs (total 253)
+
+========================= =============
+========================= =============
 IBM                        253 (100.0%)
+========================= =============
 
 Employers with the most hackers (total 27)
+
+========================= ============
+========================= ============
 IBM                         24 (88.9%)
 (Unknown)                    3 (11.1%)
+========================= ============
 
diff --git a/doc/release-notes/skiboot-5.1.1.rst b/doc/release-notes/skiboot-5.1.1.rst
index 982c082..22873e4 100644
--- a/doc/release-notes/skiboot-5.1.1.rst
+++ b/doc/release-notes/skiboot-5.1.1.rst
@@ -8,7 +8,10 @@ skiboot-5.1.1 is the send stable release of 5.1, it follows skiboot-5.1.0.
 Skiboot 5.1.1 contains all fixes from skiboot-5.1.0 and is a minor bugfix
 release.
 
+Changes
+^^^^^^^
 Over skiboot-5.1.0, we have the following changes:
+
 - Fix detection of compiler options on ancient GCC (e.g. gcc 4.4, shipped with
   RHEL6)
 - ensure the GNUC version defines for GCOV are coming from target CC rather
@@ -26,10 +29,10 @@ Over skiboot-5.1.0, we have the following changes:
   This is quite easy to verify. PCI config space access errors, for
   example, normally cause a freeze. On a CAPI-mode PHB, they should
   cause a fence. Say we have a CAPI card on PHB 0, and we inject a
-  PCI config space error:
+  PCI config space error: ::
 
-  echo 0x8000000000000000 > /sys/kernel/debug/powerpc/PCI0000/err_injct_inboundA;
-  lspci;
+   echo 0x8000000000000000 > /sys/kernel/debug/powerpc/PCI0000/err_injct_inboundA;
+   lspci;
 
   The first time we inject this, the PHB will fence and recover, but
   won't reset the registers. Therefore, the second time we inject it,
diff --git a/doc/release-notes/skiboot-5.1.10.rst b/doc/release-notes/skiboot-5.1.10.rst
index 2ba85b3..442861b 100644
--- a/doc/release-notes/skiboot-5.1.10.rst
+++ b/doc/release-notes/skiboot-5.1.10.rst
@@ -11,7 +11,9 @@ fix release.
 
 Over skiboot-5.1.9, we have the following change:
 
-IBM FSP machines:
+IBM FSP machines
+^^^^^^^^^^^^^^^^
+
 - FSP: Handle Delayed Power Off initiated CEC shutdown with FSP in Reset/Reload
 
   In a scenario where the DPO has been initiated, but the FSP then went into
@@ -19,7 +21,9 @@ IBM FSP machines:
   it may never see the PSI interrupt. So, if we are in dpo_pending and an FSP
   reset is detected via the DISR, give up the PSI link voluntarily.
 
-Generic:
+Generic
+^^^^^^^
+
 - sensor: add a compatible property
   OPAL needs an extra compatible property "ibm,opal-sensor" to make
   module autoload work smoothly in Linux for ibmpowernv driver.
diff --git a/doc/release-notes/skiboot-5.1.11.rst b/doc/release-notes/skiboot-5.1.11.rst
index b2493b2..54a2719 100644
--- a/doc/release-notes/skiboot-5.1.11.rst
+++ b/doc/release-notes/skiboot-5.1.11.rst
@@ -12,5 +12,6 @@ skiboot-5.1.11 is the 12th stable release of 5.1, it follows skiboot-5.1.10
 Skiboot 5.1.11 contains one additional bug fix over skiboot-5.1.10.
 
 It is:
+
 - On IBM FSP machines, if IPMI/Serial console is not connected during shutdown
   or reboot, machine would enter termination state rather than shut down.
diff --git a/doc/release-notes/skiboot-5.1.12.rst b/doc/release-notes/skiboot-5.1.12.rst
index 49a7e25..d2e2315 100644
--- a/doc/release-notes/skiboot-5.1.12.rst
+++ b/doc/release-notes/skiboot-5.1.12.rst
@@ -8,20 +8,28 @@ skiboot-5.1.12 is the 13th stable release of 5.1, it follows skiboot-5.1.11
 
 Skiboot 5.1.12 contains bug fixes and a performance improvement.
 
-opal-prd:
+opal-prd
+^^^^^^^^
+
 - Display an explict and obvious message if running on a system that does
   not support opal-prd, such as an IBM FSP based POWER system, where the
   FSP takes on the role of opal-prd.
 
-pflash:
+pflash
+^^^^^^
+
 - Fix a missing (C) header
   - cherry-picked from master.
 
-General:
+General
+^^^^^^^
+
 - Don't link with libgcc
   - On some toolchains, we don't have libgcc available.
 
-POWER8 PHB (PCIe) specific:
+POWER8 PHB (PCIe) specific
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 - hw/phb3: Flush cache line after updating P/Q bits
     When doing an MSI EOI, we update the P and Q bits in the IVE. That causes
     the corresponding cache line to be dirty in the L3 which will cause a
@@ -34,7 +42,9 @@ POWER8 PHB (PCIe) specific:
     This improves interrupt performance, reducing latency per interrupt.
     The improvement will vary by workload.
 
-IBM FSP based machines:
+IBM FSP based machines
+^^^^^^^^^^^^^^^^^^^^^^
+
 - FSP: Give up PSI link on shutdown
   This clears up some erroneous SRCs (error logs) in some situations.
 - Correctly report back Real Time Clock errors to host
diff --git a/doc/release-notes/skiboot-5.1.13.rst b/doc/release-notes/skiboot-5.1.13.rst
index 0bc3100..122bc1c 100644
--- a/doc/release-notes/skiboot-5.1.13.rst
+++ b/doc/release-notes/skiboot-5.1.13.rst
@@ -6,12 +6,16 @@ skiboot-5.1.13 was released on Wed January 27th, 2016.
 skiboot-5.1.13 is the 14th stable release of 5.1, it follows skiboot-5.1.12
 (which was released December 4th, 2015). This release contains bug fixes.
 
-General:
+General
+^^^^^^^
+
 - core/device.c: Sort nodes with name at unit names by unit
+
   - This gives predictable device tree ordering to the payload
     (usually petitboot)
   - This means that utilities such as "lspci" will always return the same
     ordering.
+
 - Add OPAL_CONSOLE_FLUSH to the OPAL API
   uart consoles only flush output when polled.  The Linux kernel calls
   these pollers frequently, except when in a panic state.  As such, panic
@@ -25,12 +29,16 @@ General:
   This will allow the Linux kernel to ensure that panic message have been
   fully printed out.
 
-CAPI:
+CAPI
+^^^^
+
 - hmi: Identify the phb upon CAPI malfunction alert
   Previously, any error on a CAPI adapter would assume PHB0.
   This could cause issues on Firestone machines.
 
-gard utility:
+gard utility
+^^^^^^^^^^^^
+
 - Fix displaying 'cleared' gard records
   When a garded component is replaced hostboot detects this and updates the
   gard partition.
@@ -38,6 +46,8 @@ gard utility:
   Previously, there was ambiguity on if the gard record ID or the whole gard
   record needed to be erased. This fix makes gard and hostboot agree.
 
-firestone platform:
+firestone platform
+^^^^^^^^^^^^^^^^^^
+
 - fix spacing in slot name
   The other SlotN names have no space.
diff --git a/doc/release-notes/skiboot-5.1.14.rst b/doc/release-notes/skiboot-5.1.14.rst
index 3032e77..68cf3f5 100644
--- a/doc/release-notes/skiboot-5.1.14.rst
+++ b/doc/release-notes/skiboot-5.1.14.rst
@@ -13,6 +13,7 @@ As such, skiboot-5.1.14 has no advantage over skiboot-5.1.13 unless you
 are wanting the neat offb framebuffer trick.
 
 Changes are:
+
 - fsp: fix spelling of "advertise" in log message
   See: https://www.youtube.com/watch?v=8Gv0H-vPoDc
 - Explicit 1:1 mapping in ranges properties have been added to PCI
diff --git a/doc/release-notes/skiboot-5.1.16.rst b/doc/release-notes/skiboot-5.1.16.rst
index b33a42e..fc7fab4 100644
--- a/doc/release-notes/skiboot-5.1.16.rst
+++ b/doc/release-notes/skiboot-5.1.16.rst
@@ -1,5 +1,5 @@
 skiboot-5.1.16
---------------
+==============
 
 skiboot-5.1.16 was released on Friday April 29th, 2016.
 
@@ -8,9 +8,12 @@ skiboot-5.1.16 is the 17th stable release of 5.1, it follows skiboot-5.1.15
 
 This release contains a few bug fixes and is a recommended upgrade.
 
-Changes are:
+Changes
+-------
+
+PHB3 (all POWER8 platforms)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-PHB3 (all POWER8 platforms):
 - hw/phb3: Ensure PQ bits are cleared in the IVC when masking IRQ
   When we mask an interrupt, we may race with another interrupt coming
   in from the hardware.  If this occurs, the P and/or Q bit may end up
@@ -36,17 +39,22 @@ PHB3 (all POWER8 platforms):
   what we wanted the new generation count to be if the update was
   successful.
 
-FSP platforms:
+FSP platforms
+^^^^^^^^^^^^^
+
 - OPAL:Handle mbox response with bad status:0x24 during FSP termination
   OPAL committed a predictive log with SRC BB822411 in some situations.
 
-Generic:
+Generic
+^^^^^^^
+
 - hmi: Fix a bug where partial hmi event was reported to host.
-  This bug fix ensures the CPU PIR is reported correctly:
-    [  305.628283] Fatal Hypervisor Maintenance interrupt [Not recovered]
-    [  305.628341]  Error detail: Malfunction Alert
-    [  305.628388] 	HMER: 8040000000000000
-  - [  305.628423]      CPU PIR: 00000000
-  + [  200.123021]    CPU PIR: 000008e8
-    [  305.628458]  [Unit: VSU] Logic core check stop
+  This bug fix ensures the CPU PIR is reported correctly: ::
+
+     [  305.628283] Fatal Hypervisor Maintenance interrupt [Not recovered]
+     [  305.628341]  Error detail: Malfunction Alert
+     [  305.628388] 	HMER: 8040000000000000
+   - [  305.628423]      CPU PIR: 00000000
+   + [  200.123021]    CPU PIR: 000008e8
+     [  305.628458]  [Unit: VSU] Logic core check stop
 
diff --git a/doc/release-notes/skiboot-5.1.17.rst b/doc/release-notes/skiboot-5.1.17.rst
index baacf48..d69cf7c 100644
--- a/doc/release-notes/skiboot-5.1.17.rst
+++ b/doc/release-notes/skiboot-5.1.17.rst
@@ -8,9 +8,11 @@ skiboot-5.1.17 is the 18th stable release of 5.1, it follows skiboot-5.1.16
 
 This release contains a few minor bug fixes.
 
-Changes are:
+Changes
+^^^^^^^
 
 All platforms:
+
 - Fix a few typos in user visible (OPAL log) strings
 - pci: Do a dummy config write to devices to establish bus number
 - Make the XSCOM engine code more resilient to errors:
diff --git a/doc/release-notes/skiboot-5.1.2.rst b/doc/release-notes/skiboot-5.1.2.rst
index e64932e..9af4802 100644
--- a/doc/release-notes/skiboot-5.1.2.rst
+++ b/doc/release-notes/skiboot-5.1.2.rst
@@ -9,7 +9,10 @@ skiboot-5.1.2 is the third stable release of 5.1, it follows skiboot-5.1.1
 Skiboot 5.1.2 contains all fixes from skiboot-5.1.1 and is a minor bugfix
 release.
 
+Changes
+^^^^^^^
 Over skiboot-5.1.1, we have the following changes:
+
 - phb3: Handle fence in phb3_pci_msi_check_q to fix hang
 
   If the PHB is fenced during phb3_pci_msi_check_q, it can get stuck in an
@@ -22,18 +25,22 @@ Over skiboot-5.1.1, we have the following changes:
 - phb3: Continue CAPP setup even if PHB is already in CAPP mode
   This fixes a critical bug in CAPI support.
 - Platform hook for terminate call
+
   - on assert() or other firmware failure, we will make a SEL callout
     on ASTBMC platforms
   - (slight) refactor of code for IBM-FSP platforms
+
 - refactor slot naming code
 - Slot names for Habanero platform
 - misc improvements in userspace utilities (incl pflash, gard)
 - build improvements
+
   - fixes for two compiler warnings were squashed in 5.1.1 commit,
     re-introduce the fixes.
   - misc compiler/static analysis warning fixes
 
 - gard utility:
+
   - If gard tool detects the GUARD PNOR partition is corrupted, it will
     pro-actively re-initialize it.
     Modern Hostboot is more sensitive to the content of the GUARD partition
@@ -46,25 +53,34 @@ Over skiboot-5.1.1, we have the following changes:
     to wipe the entirety of the GUARD partition to attempt recovery.
 
 - opal_prd utility:
+
   - Add run command to pass through commands to HostBoot RunTime (HBRT)
+
     - this is for OpenPower firmware developers only.
+
   - Add htmght-passthru command.
+
     - this is for OpenPower firmware developers only.
+
   - Add override interface to pass attribute-override information to HBRT.
   - Server sends response in error path, so that client doesn't block forever
 
 - external/mambo tcl scripts
+
   - Running little-endian kernels in mambo requires HILE to be set properly,
     which requires a bump in the machine's pvr value to a DD2.x chip.
 
 Stats
------
+^^^^^
 For skiboot-5.1.0 to 5.1.2:
 Processed 67 csets from 11 developers
 1 employers found
 A total of 2258 lines added, 784 removed (delta 1474)
 
 Developers with the most changesets
+
+=========================== ==========
+=========================== ==========
 Stewart Smith               24 (35.8%)
 Cyril Bur                   18 (26.9%)
 Vasant Hegde                 8 (11.9%)
@@ -76,8 +92,12 @@ Vaidyanathan Srinivasan      1 (1.5%)
 Vipin K Parashar             1 (1.5%)
 Ian Munsie                   1 (1.5%)
 Michael Neuling              1 (1.5%)
+=========================== ==========
 
 Developers with the most changed lines
+
+========================== ===========
+========================== ===========
 Cyril Bur                  969 (42.5%)
 Neelesh Gupta              433 (19.0%)
 Benjamin Herrenschmidt     304 (13.3%)
@@ -89,37 +109,74 @@ Ian Munsie                   8 (0.4%)
 Daniel Axtens                2 (0.1%)
 Michael Neuling              2 (0.1%)
 Samuel Mendoza-Jonas         1 (0.0%)
+========================== ===========
 
 Developers with the most lines removed
+
+========================== ==========
+========================== ==========
 Daniel Axtens                2 (0.3%)
 Michael Neuling              1 (0.1%)
+========================== ==========
 
 Developers with the most signoffs (total 44)
+
+========================== ==========
+========================== ==========
 Stewart Smith               43 (97.7%)
 Neelesh Gupta                1 (2.3%)
+========================== ==========
 
 Developers with the most reviews (total 8)
+
+========================== ==========
+========================== ==========
 Patrick Williams             5 (62.5%)
 Samuel Mendoza-Jonas         3 (37.5%)
+========================== ==========
 
 Developers with the most test credits (total 0)
 
 Developers who gave the most tested-by credits (total 0)
 
 Developers with the most report credits (total 1)
+
+========================== ==========
+========================== ==========
 Benjamin Herrenschmidt       1 (100.0%)
+========================== ==========
 
 Developers who gave the most report credits (total 1)
+
+========================== ==========
+========================== ==========
 Samuel Mendoza-Jonas         1 (100.0%)
+========================== ==========
 
 Top changeset contributors by employer
+
+========================== ==========
+========================== ==========
 IBM                         67 (100.0%)
+========================== ==========
 
 Top lines changed by employer
+
+========================= ==========
+========================= ==========
 IBM                       2281 (100.0%)
+========================= ==========
 
 Employers with the most signoffs (total 44)
+
+========================== ==========
+========================== ==========
 IBM                         44 (100.0%)
+========================== ==========
 
 Employers with the most hackers (total 11)
+
+========================== ==========
+========================== ==========
 IBM                         11 (100.0%)
+========================== ==========
diff --git a/doc/release-notes/skiboot-5.1.3.rst b/doc/release-notes/skiboot-5.1.3.rst
index 7c69fd6..f80046e 100644
--- a/doc/release-notes/skiboot-5.1.3.rst
+++ b/doc/release-notes/skiboot-5.1.3.rst
@@ -9,14 +9,18 @@ skiboot-5.1.3 is the 4th stable release of 5.1, it follows skiboot-5.1.2
 Skiboot 5.1.3 contains all fixes from skiboot-5.1.2 and is a minor bugfix
 release.
 
+Changes
+^^^^^^^
 Over skiboot-5.1.2, we have the following changes:
 
 - slot names for firestone platform
 - fix display of LPC errors
 - SBE based timer support
+
   - on supported platforms limits reliance on Linux heartbeat
 - fix use-after-free in fsp/ipmi
 - fix hang on TOD/TB errors (time-of-day/timebase) on OpenPower systems
+
   - On getting a Hypervizor Maintenance Interrupt to get the timebase
     back into a running state, we would call prlog which would use
     the LPC UART console driver on OpenPower systems, which depends on
@@ -26,67 +30,112 @@ Over skiboot-5.1.2, we have the following changes:
 - PCI: Clear error bits after changing MPS
   Chaning MPS on PCI upstream bridge might cause error bits set on
   downstream endpoints when system boots into Linux as below case
-  shows:
-  host# lspci -vvs 0001:06:00.0
-  0001:06:00.0 Ethernet controller: Broadcom Corporation \
-               NetXtreme II BCM57810 10 Gigabit Ethernet (rev 10)
-  DevSta:	CorrErr+ UncorrErr- FatalErr- UnsuppReq+ AuxPwr- TransPend-
-  CESta:	RxErr- BadTLP- BadDLLP- Rollover- Timeout- NonFatalErr+
+  shows: ::
+
+   host# lspci -vvs 0001:06:00.0
+   0001:06:00.0 Ethernet controller: Broadcom Corporation \
+                NetXtreme II BCM57810 10 Gigabit Ethernet (rev 10)
+   DevSta:	CorrErr+ UncorrErr- FatalErr- UnsuppReq+ AuxPwr- TransPend-
+   CESta:	RxErr- BadTLP- BadDLLP- Rollover- Timeout- NonFatalErr+
 
   This clears those error bits in AER and PCIe capability after MPS
   is changed. With the patch applied, no more error bits are seen.
 
 Contributors
-------------
+^^^^^^^^^^^^
 Processed 14 csets from 6 developers
 1 employers found
 A total of 462 lines added, 163 removed (delta 299)
 
 Developers with the most changesets
+
+============================ =========
+============================ =========
 Benjamin Herrenschmidt       5 (35.7%)
 Stewart Smith                4 (28.6%)
 Mahesh Salgaonkar            2 (14.3%)
 Gavin Shan                   1 (7.1%)
 Jeremy Kerr                  1 (7.1%)
 Neelesh Gupta                1 (7.1%)
+============================ =========
 
 Developers with the most changed lines
+
+========================== ===========
+========================== ===========
 Benjamin Herrenschmidt     407 (80.8%)
 Mahesh Salgaonkar           23 (4.6%)
 Gavin Shan                  19 (3.8%)
 Stewart Smith               18 (3.6%)
 Jeremy Kerr                  5 (1.0%)
 Neelesh Gupta                2 (0.4%)
+========================== ===========
 
 Developers with the most lines removed
+
+========================== ===========
+========================== ===========
 Stewart Smith                8 (4.9%)
 Jeremy Kerr                  3 (1.8%)
 Neelesh Gupta                1 (0.6%)
+========================== ===========
 
 Developers with the most signoffs (total 10)
+
+========================== ===========
+========================== ===========
 Stewart Smith               10 (100.0%)
+========================== ===========
 
 Developers with the most reviews (total 1)
+
+========================== ===========
+========================== ===========
 Joel Stanley                 1 (100.0%)
+========================== ===========
 
 Developers with the most test credits (total 0)
 
 Developers who gave the most tested-by credits (total 0)
 
 Developers with the most report credits (total 1)
+
+========================== ===========
+========================== ===========
 John Walthour                1 (100.0%)
+========================== ===========
 
 Developers who gave the most report credits (total 1)
+
+========================== ===========
+========================== ===========
 Gavin Shan                   1 (100.0%)
+========================== ===========
 
 Top changeset contributors by employer
+
+========================== ===========
+========================== ===========
 IBM                         14 (100.0%)
+========================== ===========
 
 Top lines changed by employer
+
+========================== ===========
+========================== ===========
 IBM                        504 (100.0%)
+========================== ===========
 
 Employers with the most signoffs (total 10)
+
+========================== ===========
+========================== ===========
 IBM                         10 (100.0%)
+========================== ===========
 
 Employers with the most hackers (total 6)
+
+========================== ===========
+========================== ===========
 IBM                          6 (100.0%)
+========================== ===========
diff --git a/doc/release-notes/skiboot-5.1.4.rst b/doc/release-notes/skiboot-5.1.4.rst
index 0ee06e1..1d5ec7d 100644
--- a/doc/release-notes/skiboot-5.1.4.rst
+++ b/doc/release-notes/skiboot-5.1.4.rst
@@ -10,6 +10,8 @@ Skiboot 5.1.4 contains all fixes from skiboot-5.1.3 and is an important bug
 fix release and a strongly recommended update from any prior skiboot-5.1.x
 release.
 
+Changes
+^^^^^^^
 Over skiboot-5.1.3, we have the following changes:
 
 - Rate limit OPAL_MSG_OCC to only one outstanding message to host
diff --git a/doc/release-notes/skiboot-5.1.5.rst b/doc/release-notes/skiboot-5.1.5.rst
index 7b594bf..e619d4e 100644
--- a/doc/release-notes/skiboot-5.1.5.rst
+++ b/doc/release-notes/skiboot-5.1.5.rst
@@ -9,9 +9,12 @@ skiboot-5.1.5 is the 6th stable release of 5.1, it follows skiboot-5.1.4
 Skiboot 5.1.5 contains all fixes from skiboot-5.1.4 and is a minor bug
 fix release.
 
+Changes
+^^^^^^^
 Over skiboot-5.1.4, we have the following changes:
 
-Generic:
+Generic
+^^^^^^^
 - centaur: Add indirect XSCOM support
   Fixes a bug where opal-prd would not be able to recover from a bunch
   of errors as the indirect XSCOMs to centaurs would fail.
@@ -21,7 +24,9 @@ Generic:
 - Improvement in boot_test.sh utility to support copying a pflash binary
   to BMCs.
 
-AST BMC machines:
+AST BMC machines
+^^^^^^^^^^^^^^^^
+
 - ipmi-sel: Run power action immediately if host not up
     Our normal sequence for a soft power action (IPMI 'power soft' or
     'power cycle') involve receiving a SEL from the BMC, sending a message
@@ -33,6 +38,8 @@ AST BMC machines:
     the action immediately if we know how.
 
 OpenPower machines:
+^^^^^^^^^^^^^^^^^^^
+
 - opal-prd: Increase IPMI timeout to a slightly better value
   Proactively bump the timeout to 5seconds to match current value in petitboot
   Observed in the wild that this fixes bugs for petitboot.
diff --git a/doc/release-notes/skiboot-5.1.6.rst b/doc/release-notes/skiboot-5.1.6.rst
index 12ad0f9..ee7df78 100644
--- a/doc/release-notes/skiboot-5.1.6.rst
+++ b/doc/release-notes/skiboot-5.1.6.rst
@@ -1,5 +1,5 @@
 skiboot-5.1.6
--------------
+=============
 
 skiboot-5.1.6 was released on October 8th, 2015.
 
@@ -9,9 +9,13 @@ skiboot-5.1.6 is the 7th stable release of 5.1, it follows skiboot-5.1.5
 Skiboot 5.1.6 contains all fixes from skiboot-5.1.5 and is a minor bug
 fix release.
 
+Changes
+-------
 Over skiboot-5.1.5, we have the following changes:
 
 Generic:
+^^^^^^^^
+
 - Ensure we run pollers in cpu_wait_job()
 
   In root causing a bug on AST BMC Alistair found that pollers weren't
@@ -20,7 +24,9 @@ Generic:
   This could show as not resetting the boot count sensor on successful
   boot.
 
-AST BMC Machines:
+AST BMC Machines
+^^^^^^^^^^^^^^^^
+
 - hw/bt.c: Check for timeout after checking for message response
 
   When deciding if a BT message has timed out we should first check for
diff --git a/doc/release-notes/skiboot-5.1.7.rst b/doc/release-notes/skiboot-5.1.7.rst
index 29f9ed5..b678b42 100644
--- a/doc/release-notes/skiboot-5.1.7.rst
+++ b/doc/release-notes/skiboot-5.1.7.rst
@@ -12,6 +12,7 @@ fix release with one important bug fix for FSP systems.
 Over skiboot-5.1.6, we have the following changes:
 
 Generic:
+
 - PHB3: Retry fundamental reset
     This introduces another PHB3 state (PHB3_STATE_FRESET_START)
     allowing to redo fundamental reset if the link doesn't come up
@@ -20,6 +21,7 @@ Generic:
     the 2nd reset won't be issued at all.
 
 FSP based systems:
+
 - hw/fsp/fsp-leds.c: use allocated buffer for FSP_CMD_GET_LED_LIST response
 
   This fixes a bug where we would overwrite roughly 4kb of memory belonging
diff --git a/doc/release-notes/skiboot-5.1.9.rst b/doc/release-notes/skiboot-5.1.9.rst
index f6460ee..f5fa7d8 100644
--- a/doc/release-notes/skiboot-5.1.9.rst
+++ b/doc/release-notes/skiboot-5.1.9.rst
@@ -10,6 +10,7 @@ Skiboot 5.1.9 contains all fixes from skiboot-5.1.8 and is a minor bug
 fix release, with a single fix to help diagnosis after a rare error condition.
 
 Over skiboot-5.1.8, we have the following change:
+
 - opal/hmi: Signal PRD about NX unit checkstop.
   We now signal Processor Recovery & Diagnostics (PRD) correctly following
   an NX unit checkstop
-- 
2.7.4



More information about the Skiboot mailing list