docs/man: Provide properly-formatted NAME sections
authorIan Jackson <ian.jackson@citrix.com>
Wed, 3 Oct 2018 17:42:42 +0000 (18:42 +0100)
committerHans van Kranenburg <hans@knorrie.org>
Thu, 1 Oct 2020 12:50:58 +0000 (13:50 +0100)
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 <ian.jackson@citrix.com>
Gbp-Pq: Name 0011-docs-man-Provide-properly-formatted-NAME-sections.patch

docs/man/xen-pci-device-reservations.pod.7
docs/man/xen-pv-channel.pod.7
docs/man/xen-tscmode.pod.7
docs/man/xen-vtpm.pod.7
docs/man/xen-vtpmmgr.pod.7
docs/man/xl-numa-placement.pod.7

index dac92764fc049580fe65baafec94e5fccc213511..049e47410fe69e8cf0df8584c4088f9102b8868e 100644 (file)
@@ -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
index 7229b26d0699efd55a717967df1aa62a5575137f..f9f01084889c921437338a798d939347ef2df6bd 100644 (file)
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-Xen PV Channels
+xen-pv-channel - Xen PV Channels
 
 =head1 DESCRIPTION
 
index 3bbc96f201d58595ae3ea8328918474842a5af5c..819c61dd0537ad1f6b642a0cc68cf7ef5d6cb254 100644 (file)
@@ -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
index 8de67f4d94185cd0ad54ce67207b130d4aaf23e6..1d8185616a46d7651d4afa1a14fca927dd3bc418 100644 (file)
@@ -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
index 2c3a2de8aa98005b8ec99c980c35cf743bd8d599..af825a7ffe44da4dbea52020b3109567bcad7cf1 100644 (file)
@@ -1,3 +1,7 @@
+=head1 NAME
+
+xen-vtpmgr - Xen virtual TPM stubdomain
+
 =head1 Authors
 
 =over 4
index 54a444172e56e10c0cd61b3acddd7cb9f77e8956..ae8330207edb56376e70c63c7fc19b0a704ffd6f 100644 (file)
@@ -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