Commit ad9b48c5 authored by Adam Zerella's avatar Adam Zerella Committed by Michael Ellerman
Browse files

docs: powerpc: Add missing documentation reference 



The documentation pages for 'elfnote' and 'ultravisor'
are not included in the powerpc documentation index, this
generates Sphinx warnings:

WARNING: document isn't included in any toctree

Additionally, when one includes these missing doc pages,
more Sphinx warnings appear. Unused footnote references,
syntax highlighting and table of content ordering has
been adjusted.

Signed-off-by: default avatarAdam Zerella <adam.zerella@gmail.com>
Signed-off-by: default avatarMichael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20190915052905.13431-1-adam.zerella@gmail.com
parent 855d9140

Documentation/powerpc/elfnote.rst

+14 −15
Original line number Diff line number Diff line
@@ -8,8 +8,7 @@ capabilities and information which can be used by a bootloader or userland. 
Types and Descriptors

---------------------



The types to be used with the "PowerPC" namesapce are defined in the

include/uapi/asm/elfnote.h

The types to be used with the "PowerPC" namesapce are defined in [#f1]_.



	1) PPC_ELFNOTE_CAPABILITIES
@@ -18,6 +17,8 @@ bitmap as "descriptor" field. Each bit is described below: 


- Ultravisor-capable bit (PowerNV only).



.. code-block:: c



	#define PPCCAP_ULTRAVISOR_BIT (1 << 0)



Indicate that the powerpc kernel binary knows how to run in an
@@ -36,7 +37,5 @@ bitmap as "descriptor" field. Each bit is described below: 
References

----------



arch/powerpc/include/asm/elfnote.h

arch/powerpc/kernel/note.S



.. [#f1] arch/powerpc/include/asm/elfnote.h

Documentation/powerpc/index.rst

+2 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ powerpc 
    dawr-power9

    dscr

    eeh-pci-error-recovery

    elfnote

    firmware-assisted-dump

    hvcs

    isa-versions
@@ -25,6 +26,7 @@ powerpc 
    qe_firmware

    syscall64-abi

    transactional_memory

    ultravisor



.. only::  subproject and html

Documentation/powerpc/ultravisor.rst

+5 −8
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0

.. _ultravisor:

.. _ultravisor:



============================

Protected Execution Facility
@@ -8,9 +8,6 @@ Protected Execution Facility 
.. contents::

    :depth: 3



.. sectnum::

    :depth: 3



Protected Execution Facility

############################
@@ -255,7 +252,7 @@ Ultravisor calls API 
    be made available in the public/OpenPower version of the PAPR

    specification.



    **Note**

    .. note::



        If PEF is not enabled, the ultracalls will be redirected to the

        Hypervisor which must handle/fail the calls.
@@ -1054,4 +1051,4 @@ Use cases 
References

##########



.. [1] `Supporting Protected Computing on IBM Power Architecture <https://developer.ibm.com/articles/l-support-protected-computing/>`_
 
- `Supporting Protected Computing on IBM Power Architecture <https://developer.ibm.com/articles/l-support-protected-computing/>`_

CRA Git | Maintained and supported by SUSTech CRA and CCSE