Merge pull request #2985 from stewart-ibm/doc-updates
doc: Add pointers to a variety of useful videos, misc fixes
diff --git a/doc/conf.py b/doc/conf.py
index dc2f9f0..3e137ce 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -31,7 +31,9 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.intersphinx',
- 'sphinx.ext.githubpages']
+ 'sphinx.ext.githubpages',
+ 'sphinxcontrib.youtube',
+]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -163,5 +165,5 @@
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/', None),
'skiboot': ('https://open-power.github.io/skiboot/doc/', None),
- 'op-test': ('https://open-power.github.io/op-test-framework/', None),
+ 'op-test': ('https://open-power.github.io/op-test/', None),
}
diff --git a/doc/introduction.rst b/doc/introduction.rst
index 9fde475..260f870 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -12,6 +12,8 @@
image. `op-build` is a "Buildroot overlay". We build a kernel and initramfs
using buildroot to run the Petitboot boot loader in. We maintain a branch
with a minimum number of patches on top of upstream buildroot.
+op-build_
+ A buildroot overlay that assembles OpenPOWER Firmware images.
SBE_
the Self Boot Engine is the first unit inside the POWER processor to start
executing. It's job is to set up a core and load Hostboot.
@@ -36,11 +38,81 @@
The bootloader. It is a normal user-space process running on Linux that
searches the system for disks and network devices that it can boot the
OS from.
+HCODE_
+ Firmware for the power management PPE. Implements heavy lifting for deeper
+ STOP states.
.. _Buildroot: https://github.com/open-power/buildroot
+.. _op-build: https://github.com/open-power/op-build
.. _SBE: https://github.com/open-power/sbe
.. _OCC: https://github.com/open-power/occ
.. _Hostboot: https://github.com/open-power/hostboot
.. _skiboot: https://open-power.github.io/skiboot/
.. _Linux: https://github.com/open-power/linux
.. _Petitboot: https://github.com/open-power/petitboot/
+.. _HCODE: https://github.com/open-power/hcode
+
+Introductory Videos
+-------------------
+
+There are a number of good recorded presentations from various conferences
+around the world that have overviews and deep dives into various parts of
+the firmware stack.
+
+Here, we present technical presentations that may be useful in learning
+about topics relevant to OpenPOWER firmware development.
+
+For broader OpenPOWER topics, check out the following channels:
+
+- `OpenPOWER Foundation` <https://github.com/open-power/op-build/pull/2983>`_
+
+Introductory
+^^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=a4XGvssR-ag
+.. youtube:: https://www.youtube.com/watch?v=hcLhKjxa-40
+
+Secure Boot
+^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=hwB1bkXQep4
+
+Interfaces and standards
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=2TroT3ORw0s
+
+OpenCAPI
+^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=h3pLBDCqY-I
+
+.. youtube:: https://www.youtube.com/watch?v=K4dhx0ctjkQ
+
+XIVE Interrupt Controller
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=s88beMQWkks
+
+Petitboot
+^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=4JbDb4bRBK4
+.. youtube:: https://www.youtube.com/watch?v=oxmMJMibZQ8
+
+Booting Faster
+^^^^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=fTLsS_QZ8us
+
+Testing
+^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=znEM2xqJhBU
+
+Bringup and customisation
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. youtube:: https://www.youtube.com/watch?v=v73Nw7NDxYI
+
+.. youtube:: https://www.youtube.com/watch?v=dBEBQQYP_eI
diff --git a/doc/process/KernelTree.rst b/doc/process/KernelTree.rst
index 4a793ff..4ed0bdd 100644
--- a/doc/process/KernelTree.rst
+++ b/doc/process/KernelTree.rst
@@ -1,7 +1,7 @@
op-build Linux Kernel
=====================
-The skiroot/Petitboot kernel is currently based on the 4.19 series.
+The skiroot/Petitboot kernel is currently based on the 5.1 series.
Submitting a patch
------------------
@@ -13,7 +13,8 @@
2. Send a pull request or a ``git format-patch`` formatted patch series
to openpower-firmware@lists.ozlabs.org, and cc joel@jms.id.au. Be
sure to use ``--suppress-cc=sob`` when generating the patches so we
- don’t spam the community. The current tree is based on 4.15-stable.
+ don’t spam the community. The current tree is based on 5.1-stable
+ (although we will always move to the latest stable kernel ASAP).
Bug fixes
---------
@@ -58,6 +59,10 @@
This way we don’t have to clone an entire tree when doing an op-build
build.
+All patches are to head upstream *first*. There is a zero chance that
+op-build will carry kernel patches for any time greater than "until the
+next kernel release", and even then, only in *exceptional* circumstances.
+
Patches in the tree
-------------------
diff --git a/doc/requirements.txt b/doc/requirements.txt
index b510d7c..0067768 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,3 +1,4 @@
# Pinned due to https://github.com/sphinx-doc/sphinx/issues/5419
sphinx==1.7.9
recommonmark
+sphinxcontrib.youtube