[xen master] docs/man: Provide properly-formatted NAME sections

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[xen master] docs/man: Provide properly-formatted NAME sections

patchbot
commit 423c4def1f7a01eeff56fa70564180640ef3af43
Author:     Ian Jackson <[hidden email]>
AuthorDate: Wed Oct 3 18:42:42 2018 +0100
Commit:     Ian Jackson <[hidden email]>
CommitDate: Mon Oct 8 15:20:19 2018 +0100

    docs/man: Provide properly-formatted NAME sections
   
    A manpage `foo.7.pod' must start with
   
      =head NAME
   
      foo - some summary of what foo is or what this manpage is
   
    because otherwise manpage catalogue systems cannot generate a proper
    `whatis' entry.
   
    Signed-off-by: Ian Jackson <[hidden email]>
    Acked-by: Wei Liu <[hidden email]>
---
 docs/man/xen-pci-device-reservations.pod.7 | 4 ++++
 docs/man/xen-pv-channel.pod.7              | 2 +-
 docs/man/xen-tscmode.pod.7                 | 4 ++++
 docs/man/xen-vtpm.pod.7                    | 6 ++++++
 docs/man/xen-vtpmmgr.pod.7                 | 4 ++++
 docs/man/xl-numa-placement.pod.7           | 2 +-
 6 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/docs/man/xen-pci-device-reservations.pod.7 b/docs/man/xen-pci-device-reservations.pod.7
index dac92764fc..049e47410f 100644
--- a/docs/man/xen-pci-device-reservations.pod.7
+++ b/docs/man/xen-pci-device-reservations.pod.7
@@ -1,3 +1,7 @@
+=head1 NAME
+
+xen-pci-device-reservations - Xen PCI device ID registry
+
 =head1 Description
 
 PCI vendor ID 0x5853 has been reserved for use by Xen systems in order to
diff --git a/docs/man/xen-pv-channel.pod.7 b/docs/man/xen-pv-channel.pod.7
index 7229b26d06..f9f0108488 100644
--- a/docs/man/xen-pv-channel.pod.7
+++ b/docs/man/xen-pv-channel.pod.7
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-Xen PV Channels
+xen-pv-channel - Xen PV Channels
 
 =head1 DESCRIPTION
 
diff --git a/docs/man/xen-tscmode.pod.7 b/docs/man/xen-tscmode.pod.7
index 3bbc96f201..819c61dd05 100644
--- a/docs/man/xen-tscmode.pod.7
+++ b/docs/man/xen-tscmode.pod.7
@@ -1,3 +1,7 @@
+=head1 NAME
+
+xen-tscmode - Xen TSC (time stamp counter) and timekeeping discussion
+
 =head1 OVERVIEW
 
 As of Xen 4.0, a new config option called tsc_mode may be specified
diff --git a/docs/man/xen-vtpm.pod.7 b/docs/man/xen-vtpm.pod.7
index 8de67f4d94..1d8185616a 100644
--- a/docs/man/xen-vtpm.pod.7
+++ b/docs/man/xen-vtpm.pod.7
@@ -1,3 +1,9 @@
+=head1 NAME
+
+xen-vtpm - Xen virtual Trusted Platform Module (vTPM) subsystem
+
+=head1 RUBRIC
+
 Copyright (c) 2010-2012 United States Government, as represented by
 the Secretary of Defense.  All rights reserved.
 November 12 2012
diff --git a/docs/man/xen-vtpmmgr.pod.7 b/docs/man/xen-vtpmmgr.pod.7
index 2c3a2de8aa..af825a7ffe 100644
--- a/docs/man/xen-vtpmmgr.pod.7
+++ b/docs/man/xen-vtpmmgr.pod.7
@@ -1,3 +1,7 @@
+=head1 NAME
+
+xen-vtpmgr - Xen virtual TPM stubdomain
+
 =head1 Authors
 
 =over 4
diff --git a/docs/man/xl-numa-placement.pod.7 b/docs/man/xl-numa-placement.pod.7
index 54a444172e..ae8330207e 100644
--- a/docs/man/xl-numa-placement.pod.7
+++ b/docs/man/xl-numa-placement.pod.7
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-Guest Automatic NUMA Placement in libxl and xl
+xl-numa-placement - Guest Automatic NUMA Placement in libxl and xl
 
 =head1 DESCRIPTION
 
--
generated by git-patchbot for /home/xen/git/xen.git#master

_______________________________________________
Xen-changelog mailing list
[hidden email]
https://lists.xenproject.org/xen-changelog