Re: [Xen-devel] [PATCH 07/11] docs: move vtpm from misc to man

[Cedric Bosdonnat]

On Wed, 2016-12-14 at 16:08 -0500, Daniel De Graaf wrote:
> On 12/09/2016 11:17 AM, Cédric Bosdonnat wrote:
> > vtpm.txt is referenced in xl.cfg man page. Convert it to pod,
> > move it to the man folder and update the reference.
> > 
> > Signed-off-by: Cédric Bosdonnat 
> 
> Since this manpage only describes Xen's vTPM implementation, and
> Xen is not the only vTPM that exists in Linux (there's a Linux
> kernel "vtpm_proxy" interface and another ibmvtpm module), I think
> it needs be named something like "xen-vtpm".  The same applies to
> patch 8 (vtpmmgr) as that manpage (and software) is Xen-specific.

I just changed the names locally. I'll resubmit after having gathered
a few more comments.

Thanks for your review.

--
Cedric

> The POD sources look correct, though I have not compiled & looked
> at the resulting manpages.


___
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

Re: [Xen-devel] [PATCH 07/11] docs: move vtpm from misc to man

[Daniel De Graaf]

On 12/09/2016 11:17 AM, Cédric Bosdonnat wrote:

vtpm.txt is referenced in xl.cfg man page. Convert it to pod,
move it to the man folder and update the reference.

Signed-off-by: Cédric Bosdonnat 


Since this manpage only describes Xen's vTPM implementation, and
Xen is not the only vTPM that exists in Linux (there's a Linux
kernel "vtpm_proxy" interface and another ibmvtpm module), I think
it needs be named something like "xen-vtpm".  The same applies to
patch 8 (vtpmmgr) as that manpage (and software) is Xen-specific.

The POD sources look correct, though I have not compiled & looked
at the resulting manpages.

--
Daniel De Graaf
National Security Agency

___
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

[Xen-devel] [PATCH 07/11] docs: move vtpm from misc to man

[Cédric Bosdonnat]

vtpm.txt is referenced in xl.cfg man page. Convert it to pod,
move it to the man folder and update the reference.

Signed-off-by: Cédric Bosdonnat 
---
 docs/INDEX |   1 -
 docs/{misc/vtpm.txt => man/vtpm.pod.7} | 364 +
 docs/man/xl.cfg.pod.5.in   |   3 +-
 3 files changed, 194 insertions(+), 174 deletions(-)
 rename docs/{misc/vtpm.txt => man/vtpm.pod.7} (57%)

diff --git a/docs/INDEX b/docs/INDEX
index 101d43c7aa..66cc82b78c 100644
--- a/docs/INDEX
+++ b/docs/INDEX
@@ -18,7 +18,6 @@ misc/xenstore-paths   Xenstore path documentation
 misc/distro_mappingDistro Directory Layouts
 misc/dump-core-format  Xen Core Dump Format
 misc/vtd   VT-d HOWTO
-misc/vtpm  Virtual TPM
 misc/xen-error-handlingXen Error Handling
 misc/xenpaging Xen Paging
 misc/xsm-flask XSM/FLASK Configuration
diff --git a/docs/misc/vtpm.txt b/docs/man/vtpm.pod.7
similarity index 57%
rename from docs/misc/vtpm.txt
rename to docs/man/vtpm.pod.7
index 1887d40d25..03bde1d4eb 100644
--- a/docs/misc/vtpm.txt
+++ b/docs/man/vtpm.pod.7
@@ -7,9 +7,8 @@ This document describes the virtual Trusted Platform Module 
(vTPM) subsystem
 for Xen. The reader is assumed to have familiarity with building and installing
 Xen, Linux, and a basic understanding of the TPM and vTPM concepts.
 
---
-INTRODUCTION
---
+=head1 INTRODUCTION
+
 The goal of this work is to provide a TPM functionality to a virtual guest
 operating system (a DomU).  This allows programs to interact with a TPM in a
 virtual system the same way they interact with a TPM on the physical system.
@@ -25,99 +24,114 @@ mini-os to reduce memory and processor overhead.
 This mini-os vTPM subsystem was built on top of the previous vTPM work done by
 IBM and Intel corporation.
  
---
-DESIGN OVERVIEW
---
+=head1 DESIGN OVERVIEW
 
 The architecture of vTPM is described below:
 
-+--+
-|Linux DomU| ...
-|   |  ^   |
-|   v  |   |
-|   xen-tpmfront   |
-+--+
-|  ^
-v  |
-+--+
-| mini-os/tpmback  |
-|   |  ^   |
-|   v  |   |
-|  vtpm-stubdom| ...
-|   |  ^   |
-|   v  |   |
-| mini-os/tpmfront |
-+--+
-|  ^
-v  |
-+--+
-| mini-os/tpmback  |
-|   |  ^   |
-|   v  |   |
-| vtpmmgr-stubdom  |
-|   |  ^   |
-|   v  |   |
-| mini-os/tpm_tis  |
-+--+
-|  ^
-v  |
-+--+
-|   Hardware TPM   |
-+--+
- * Linux DomU: The Linux based guest that wants to use a vTPM. There many be
-   more than one of these.
-
- * xen-tpmfront.ko: Linux kernel virtual TPM frontend driver. This driver
-provides vTPM access to a para-virtualized Linux based 
DomU.
-
- * mini-os/tpmback: Mini-os TPM backend driver. The Linux frontend driver
-connects to this backend driver to facilitate
-communications between the Linux DomU and its vTPM. This
-driver is also used by vtpmmgr-stubdom to communicate with
-vtpm-stubdom.
-
- * vtpm-stubdom: A mini-os stub domain that implements a vTPM. There is a
- one to one mapping between running vtpm-stubdom instances and
- logical vtpms on the system. The vTPM Platform Configuration
- Registers (PCRs) are all initialized to zero.
-
- * mini-os/tpmfront: Mini-os TPM frontend driver. The vTPM mini-os domain
- vtpm-stubdom uses this driver to communicate with
- vtpmmgr-stubdom. This driver could also be used 
separately to
- implement a mini-os domain that wishes to use a vTPM of
- its own.
-
- * vtpmmgr-stubdom: A mini-os domain that implements the vTPM manager.
-   There is only one vTPM manager and it should be running during
-   the entire lifetime of the machine.  This domain regulates
-   access to the physical TPM on the system and secures the
-   persistent state of each vTPM.
-
- * mini-os/tpm_tis: Mini-os TPM version 1.2 TPM Interface Specification (TIS)
-driver. This driver used by vtpmmgr-stubdom to talk 
directly to
-the hardware TPM. Communication is facilitated by mapping
-hardware memory pages into vtpmmgr-stubdom.
-
- * Hardware TPM: The physical TPM that is soldered onto the motherboard.
-
---
-INSTALLATION
---
-
-Prerequisites:
---
++--+
+|Linux DomU| ...
+|   |