[PATCH] docs: powerpc: Add missing documentation reference

[PATCH] docs: powerpc: Add missing documentation reference

[Adam Zerella]

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: Adam Zerella <adam.zerella@gmail.com>
---
 Documentation/powerpc/elfnote.rst    | 29 ++++++++++++++--------------
 Documentation/powerpc/index.rst      |  2 ++
 Documentation/powerpc/ultravisor.rst | 13 +++++--------
 3 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/Documentation/powerpc/elfnote.rst b/Documentation/powerpc/elfnote.rst
index 2a5c4beeb809..06602248621c 100644
--- a/Documentation/powerpc/elfnote.rst
+++ b/Documentation/powerpc/elfnote.rst
@@ -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,25 +17,25 @@ 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
-	ultravisor-enabled system.
+Indicate that the powerpc kernel binary knows how to run in an
+ultravisor-enabled system.
 
-	In an ultravisor-enabled system, some machine resources are now controlled
-	by the ultravisor. If the kernel is not ultravisor-capable, but it ends up
-	being run on a machine with ultravisor, the kernel will probably crash
-	trying to access ultravisor resources. For instance, it may crash in early
-	boot trying to set the partition table entry 0.
+In an ultravisor-enabled system, some machine resources are now controlled
+by the ultravisor. If the kernel is not ultravisor-capable, but it ends up
+being run on a machine with ultravisor, the kernel will probably crash
+trying to access ultravisor resources. For instance, it may crash in early
+boot trying to set the partition table entry 0.
 
-	In an ultravisor-enabled system, a bootloader could warn the user or prevent
-   	the kernel from being run if the PowerPC ultravisor capability doesn't exist
-	or the Ultravisor-capable bit is not set.
+In an ultravisor-enabled system, a bootloader could warn the user or prevent
+the kernel from being run if the PowerPC ultravisor capability doesn't exist
+or the Ultravisor-capable bit is not set.
 
 References
 ----------
 
-arch/powerpc/include/asm/elfnote.h
-arch/powerpc/kernel/note.S
-
+.. [#f1] arch/powerpc/include/asm/elfnote.h
 
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 549b1cdd77ae..db7b6a880f52 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -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
 
diff --git a/Documentation/powerpc/ultravisor.rst b/Documentation/powerpc/ultravisor.rst
index 94a149f34ec3..730854f73830 100644
--- a/Documentation/powerpc/ultravisor.rst
+++ b/Documentation/powerpc/ultravisor.rst
@@ -1,5 +1,5 @@
 .. 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,10 +252,10 @@ 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.
+        If PEF is not enabled, the ultracalls will be redirected to the
+        Hypervisor which must handle/fail the calls.
 
 Ultracalls used by Hypervisor
 =============================
@@ -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/>`_
-- 
2.21.0

Re: [PATCH] docs: powerpc: Add missing documentation reference

[Michael Ellerman]

On Sun, 2019-09-15 at 05:29:05 UTC, Adam Zerella wrote:
> 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: Adam Zerella <adam.zerella@gmail.com>

Applied to powerpc next, thanks.

https://git.kernel.org/powerpc/c/ad9b48c52296ddb7620e3f2b66a7479b78632dff

cheers