From: Ian Jackson <ian.jackson@citrix.com>
To: xen-devel@lists.xenproject.org
Cc: Hans van Kranenburg <hans@knorrie.org>,
Ian Jackson <ian.jackson@citrix.com>,
Ian Jackson <ian.jackson@eu.citrix.com>,
Wei Liu <wei.liu2@citrix.com>
Subject: [PATCH 11/18] docs/man: Provide properly-formatted NAME sections
Date: Fri, 5 Oct 2018 18:29:10 +0100 [thread overview]
Message-ID: <20181005172917.11963-12-ian.jackson@citrix.com> (raw)
In-Reply-To: <20181005172917.11963-1-ian.jackson@citrix.com>
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>
---
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
--
2.11.0
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2018-10-05 17:37 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-05 17:28 [PATCH 00/18] Miscellaneous build and docs, fixes from Debian Ian Jackson
2018-10-05 17:29 ` [PATCH 01/18] docs/man: Fix two typos detected by the Debian lintian tool Ian Jackson
2018-10-08 9:40 ` Wei Liu
2018-10-05 17:29 ` [PATCH 02/18] tools/xentrace/xenalyze: Fix typos detected by lintian Ian Jackson
2018-10-08 9:29 ` George Dunlap
2018-10-05 17:29 ` [PATCH 03/18] Various: Fix typos `unkown', `retreive' (detected by lintian) Ian Jackson
2018-10-08 9:42 ` Wei Liu
2018-10-05 17:29 ` [PATCH 04/18] Various: Fix typo `occured' Ian Jackson
2018-10-08 9:07 ` Jan Beulich
2018-10-08 9:30 ` George Dunlap
2018-10-05 17:29 ` [PATCH 05/18] Various: Fix typo `reseting' Ian Jackson
2018-10-08 9:42 ` Wei Liu
2018-10-05 17:29 ` [PATCH 06/18] tools/python/xen/lowlevel: Fix typo `sucess' Ian Jackson
2018-10-08 9:42 ` Wei Liu
2018-10-05 17:29 ` [PATCH 07/18] Various: Fix typo `infomation' Ian Jackson
2018-10-08 9:08 ` Jan Beulich
2018-10-08 14:11 ` Ian Jackson
2018-10-08 9:31 ` George Dunlap
2018-10-05 17:29 ` [PATCH 08/18] Various: Fix typo `mappping' Ian Jackson
2018-10-08 9:43 ` Wei Liu
2018-10-05 17:29 ` [PATCH 09/18] tools/Rules.mk: Honour PREPEND_LDFLAGS_XEN_TOOLS Ian Jackson
2018-10-05 17:29 ` [PATCH 10/18] INSTALL: Mention kconfig Ian Jackson
2018-10-07 18:27 ` Doug Goldstein
2018-10-08 14:04 ` Ian Jackson
2018-10-08 9:13 ` Jan Beulich
2018-10-08 14:08 ` Ian Jackson
2018-10-08 14:22 ` Jan Beulich
2018-10-08 14:24 ` Ian Jackson
2018-10-09 3:52 ` Doug Goldstein
2018-10-05 17:29 ` Ian Jackson [this message]
2018-10-08 9:44 ` [PATCH 11/18] docs/man: Provide properly-formatted NAME sections Wei Liu
2018-10-05 17:29 ` [PATCH 12/18] docs/man/xen-pv-channel.pod.7: Remove a spurious blank line Ian Jackson
2018-10-08 9:44 ` Wei Liu
2018-10-05 17:29 ` [PATCH 13/18] tools/xenstat: Fix shared library version Ian Jackson
2018-10-08 9:44 ` Wei Liu
2018-10-09 13:59 ` Andrew Cooper
2018-10-05 17:29 ` [PATCH 14/18] gdbsx: Honour LDFLAGS when linking Ian Jackson
2018-10-05 17:29 ` [PATCH 15/18] libfsimage: Honour general LDFLAGS Ian Jackson
2018-10-08 9:45 ` Wei Liu
2018-10-05 17:29 ` [PATCH 16/18] pygrub fsimage.so: Honour LDFLAGS when building Ian Jackson
2018-10-05 17:29 ` [PATCH 17/18] xenmon: Install as xenmon, not xenmon.py Ian Jackson
2018-10-08 9:51 ` Wei Liu
2018-10-05 17:29 ` [PATCH 18/18] tools/debugger/kdd: Install as `xen-kdd', not just `kdd' Ian Jackson
2018-10-07 16:37 ` Tim Deegan
2018-10-08 14:01 ` Ian Jackson
2018-10-08 14:29 ` Juergen Gross
2018-10-12 15:00 ` Ian Jackson
2018-10-08 14:28 ` [PATCH 00/18] Miscellaneous build and docs, fixes from Debian Ian Jackson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181005172917.11963-12-ian.jackson@citrix.com \
--to=ian.jackson@citrix.com \
--cc=hans@knorrie.org \
--cc=ian.jackson@eu.citrix.com \
--cc=wei.liu2@citrix.com \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.