linux-kernel - [PATCH 6/8] Documentation: kvx: Promote title headings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230109095108.21229-7-bagasdotme@gmail.com>
Date:   Mon,  9 Jan 2023 16:51:06 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Jonathan Corbet <corbet@....net>,
        Yann Sionneau <ysionneau@...ray.eu>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Clement Leger <clement.leger@...tlin.com>,
        Guillaume Thouvenin <gthouvenin@...ray.eu>,
        Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH 6/8] Documentation: kvx: Promote title headings

The documentation contains headings which all marked up using the same
heading level, which cause doc sections to also appear in index TOC
alongside doc titles.

Promote title headings while expanding their title text to be more
descriptive.

Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/kvx/kvx-exceptions.rst | 6 ++++--
 Documentation/kvx/kvx-iommu.rst      | 4 ++--
 Documentation/kvx/kvx-mmu.rst        | 5 +++--
 Documentation/kvx/kvx-smp.rst        | 5 +++--
 Documentation/kvx/kvx.rst            | 1 +
 5 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/Documentation/kvx/kvx-exceptions.rst b/Documentation/kvx/kvx-exceptions.rst
index bd485efd2362c1..15692f14b9219d 100644
--- a/Documentation/kvx/kvx-exceptions.rst
+++ b/Documentation/kvx/kvx-exceptions.rst
@@ -1,5 +1,7 @@
-Exceptions
-==========
+=========================
+Exception handling in kvx
+=========================
+
 On kvx, handlers are set using $ev (exception vector) register which
 specifies a base address.
 An offset is added to $ev upon exception and the result is used as
diff --git a/Documentation/kvx/kvx-iommu.rst b/Documentation/kvx/kvx-iommu.rst
index c97035ba624c22..5e84dc12adb437 100644
--- a/Documentation/kvx/kvx-iommu.rst
+++ b/Documentation/kvx/kvx-iommu.rst
@@ -1,5 +1,5 @@
-IOMMU
-=====
+IOMMU in kvx
+============
 
 General Overview
 ----------------
diff --git a/Documentation/kvx/kvx-mmu.rst b/Documentation/kvx/kvx-mmu.rst
index faa6bda2c39959..05b9bc111e02db 100644
--- a/Documentation/kvx/kvx-mmu.rst
+++ b/Documentation/kvx/kvx-mmu.rst
@@ -1,5 +1,6 @@
-MMU
-===
+==========================
+kvx Memory Management Unit
+==========================
 
 Virtual addresses are on 41 bits for kvx when using 64-bit mode.
 To differentiate kernel from user space, we use the high order bit
diff --git a/Documentation/kvx/kvx-smp.rst b/Documentation/kvx/kvx-smp.rst
index 1b69d77db8cdaf..f170bc48ea5f7f 100644
--- a/Documentation/kvx/kvx-smp.rst
+++ b/Documentation/kvx/kvx-smp.rst
@@ -1,5 +1,6 @@
-SMP
-===
+===============================================
+Symmetric Multiprocessing Implementation in kvx
+===============================================
 
 On kvx, 5 clusters are organized as groups of 16 processors + 1
 secure core (RM) for each cluster. These 17 processors are L1$ coherent
diff --git a/Documentation/kvx/kvx.rst b/Documentation/kvx/kvx.rst
index 8982d10f2678df..4aac7fce4e3d01 100644
--- a/Documentation/kvx/kvx.rst
+++ b/Documentation/kvx/kvx.rst
@@ -1,3 +1,4 @@
+=======================
 kvx Core Implementation
 =======================
 
-- 
An old man doll... just what I always wanted! - Clara