docs: use multiple header levels in virtiofs doc

[libvirt PATCH] docs: use multiple header levels in virtiofs doc

Daniel P. Berrangé posted 1 patch 3 years, 10 months ago

Download mbox

Test syntax-check failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20200601114646.2863490-1-berrange@redhat.com

docs/kbase/virtiofs.rst | 4 ----
1 file changed, 4 deletions(-)

Expand all Fold all

[libvirt PATCH] docs: use multiple header levels in virtiofs doc

Posted by Daniel P. Berrangé 3 years, 10 months ago

The heading overline should only be used for the overall document title,
any subsequent headings should be underline only.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/kbase/virtiofs.rst | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/docs/kbase/virtiofs.rst b/docs/kbase/virtiofs.rst
index 18d568af1b..dea8e79f83 100644
--- a/docs/kbase/virtiofs.rst
+++ b/docs/kbase/virtiofs.rst
@@ -4,7 +4,6 @@ Sharing files with Virtio-FS
 
 .. contents::
 
-=========
 Virtio-FS
 =========
 
@@ -14,7 +13,6 @@ is designed to offer local file system semantics and performance.
 
 See https://virtio-fs.gitlab.io/
 
-==========
 Host setup
 ==========
 
@@ -45,7 +43,6 @@ Either of the following:
 
       # virsh allocpages 2M 1024
 
-===========
 Guest setup
 ===========
 
@@ -132,7 +129,6 @@ Guest setup
 
    Note: this requires virtiofs support in the guest kernel (Linux v5.4 or later)
 
-===================
 Optional parameters
 ===================
 
-- 
2.26.2

Re: [libvirt PATCH] docs: use multiple header levels in virtiofs doc

Posted by Andrea Bolognani 3 years, 10 months ago

On Mon, 2020-06-01 at 12:46 +0100, Daniel P. Berrangé wrote:
> The heading overline should only be used for the overall document title,
> any subsequent headings should be underline only.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  docs/kbase/virtiofs.rst | 4 ----
>  1 file changed, 4 deletions(-)

Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization