Hi Andre, of Phoronix fame, On Tue, Dec 22, 2015 at 02:00:46PM +0000, Andre Przywara wrote: > The kvmtool documentation is somewhat lacking, also it is not easily > accessible when living in the source tree only. > Add a good ol' manpage to document at least the basic commands and > their options. > This level of documentation matches the one that is already there in > the Documentation directory and should be subject to extension. > > Signed-off-by: Andre Przywara <andre.przywara@xxxxxxx> > --- > Documentation/kvmtool.1 | 222 ++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 222 insertions(+) > create mode 100644 Documentation/kvmtool.1 > > diff --git a/Documentation/kvmtool.1 b/Documentation/kvmtool.1 > new file mode 100644 > index 0000000..aecb2dc > --- /dev/null > +++ b/Documentation/kvmtool.1 > @@ -0,0 +1,222 @@ > +.\" Manpage for kvmtool > +.\" Copyright (C) 2015 by Andre Przywara <andre.przywara@xxxxxxx> > +.TH kvmtool 1 "11 Nov 2015" "0.1" "kvmtool man page" > +.SH NAME > +kvmtool \- running KVM guests > +.SH SYNOPSIS > +lkvm COMMAND [ARGS] > +.SH DESCRIPTION > +kvmtool is a userland tool for creating and controlling KVM guests. > +.SH "KVMTOOL COMMANDS" > +.sp > +.PP > +.B run -k <kernel-image> ... You seem to be inconsistent with your synopses for each command. That is, here you just have -k <kernel-image> ... , but later you have things like > +.B debug --all|--name <guest name> [--dump] [--nmi <n>] [--sysrq <rq>] which describes all of the possible options to debug. I think I prefer this latter way, so could you make all of the commands look like that, please? Will -- To unsubscribe from this list: send the line "unsubscribe kvm" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
