From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:44618) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZVRSK-0005d7-2N for qemu-devel@nongnu.org; Fri, 28 Aug 2015 17:45:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZVRSF-0007tt-Un for qemu-devel@nongnu.org; Fri, 28 Aug 2015 17:45:03 -0400 Received: from mx1.redhat.com ([209.132.183.28]:43855) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZVRSF-0007tp-N7 for qemu-devel@nongnu.org; Fri, 28 Aug 2015 17:44:59 -0400 References: <1440632099-5169-1-git-send-email-marcandre.lureau@redhat.com> <1440632099-5169-14-git-send-email-marcandre.lureau@redhat.com> From: Eric Blake Message-ID: <55E0D651.2090900@redhat.com> Date: Fri, 28 Aug 2015 15:44:49 -0600 MIME-Version: 1.0 In-Reply-To: <1440632099-5169-14-git-send-email-marcandre.lureau@redhat.com> Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="jDDe2ilTVJaR8lhF7VmomhsJwJ7PM16vp" Subject: Re: [Qemu-devel] [PATCH v4 13/13] qga: start a man page List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: marcandre.lureau@redhat.com, qemu-devel@nongnu.org Cc: den@openvz.org, mdroth@linux.vnet.ibm.com This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --jDDe2ilTVJaR8lhF7VmomhsJwJ7PM16vp Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 08/26/2015 05:34 PM, marcandre.lureau@redhat.com wrote: > From: Marc-Andr=C3=A9 Lureau >=20 > Add a simple man page for the qemu agent. >=20 > Signed-off-by: Marc-Andr=C3=A9 Lureau > Reviewed-by: Michael Roth > --- > Makefile | 14 +++++- > qemu-doc.texi | 6 +++ > qemu-ga.texi | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++= ++++++++ > 3 files changed, 154 insertions(+), 2 deletions(-) > create mode 100644 qemu-ga.texi >=20 > +++ b/qemu-ga.texi > @@ -0,0 +1,136 @@ > +@example > +@c man begin SYNOPSIS > +usage: qemu-ga [-m -p ] [OPTION]... This implies that -m/-p are linked (either both or neither must be specified); and is a bit confusing since they are also OPTIONs (why are they called out when the others are not). Might be simpler to just use: usage: qemu-ga [OPTION]... > +@c man end > +@end example > + > +@c man begin DESCRIPTION > + > +The QEMU Guest Agent is a daemon that allows the host to perform > +various operations in the guest, such as: How about adding some words to make it obvious that it is not useful on bare metal and is intended for virtualized guests: The QEMU Guest Agent is a daemon intended to be run in virtual machines. It allows the hypervisor host to perform various operations in the guest, such as: > +@c man begin OPTIONS > +@table @option > +@item -m, --method=3D@var{method} > + Transport method: one of @samp{unix-listen}, @samp{virtio-serial}, o= r > + @samp{isa-serial} (@samp{virtio-serial} is the default). > + > +@item -p, --path=3D@var{path} > + Device/socket path (the default for virtio-serial is: > + @samp{/dev/virtio-ports/org.qemu.guest_agent.0}, > + the default for isa-serial is: @samp{/dev/ttyS0}) s/is:/is/ in both places > + > +@item -l, --logfile=3D@var{path} > + Set log file path, logs to stderr by default. Also, 'path' is an annoying term; POSIX folks use it for any file name, while GNU folks claim it should only be used for colon-separated lists of directories as in PATH=3D. 'name' or 'location' might be better, although I personally don't care strongly enough to reject on just that choice of naming. Elsewhere you've listed defaults in (); maybe: Set log file (default is stderr). > + > +@item -f, --pidfile=3D@var{path} > + Specify pid file (default is @samp{/var/run/qemu-ga.pid}). Same bit about 'path', here and below (I'll quit pointing it out). > + > +@item -F, --fsfreeze-hook=3D@var{path} > + Enable fsfreeze hook. Accepts an optional argument that specifies > + script to run on freeze/thaw. Script will be called with > + 'freeze'/'thaw' arguments accordingly. (default is > + @samp{/etc/qemu/fsfreeze-hook}) If using -F with an argument, do Place the '.' after the (), not before, since the 'If using' sentence starts a new thought. > + not follow -F with a space. (for example: > + @samp{-F/var/run/fsfreezehook.sh}) And again. [aside: short options that take an optional argument are wonky; POSIX discourages their use in new programs, and GNU recommends that only long options have optional arguments. But we've already shipped it that way, so too late to change it now] > +@item -b, --blacklist=3D@var{list} > + Comma-separated list of RPCs to disable (no spaces, @samp{?} to list= > + available RPCs). > + '?' requires shell quoting to avoid unintended globbing based on the contents of the current directory; in the past, we've updated 'qemu' to take 'help' as a synonym anywhere that '?' was special, so that you can query without worrying about quoting. We should probably do likewise for the agent daemon; but as a separate patch. Overall, fairly clean. --=20 Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org --jDDe2ilTVJaR8lhF7VmomhsJwJ7PM16vp Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Public key at http://people.redhat.com/eblake/eblake.gpg Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJV4NZRAAoJEKeha0olJ0Nqxd0H/RGnw0nSo1qRt+wLIO0ElHy4 1VAsIEp1h4arRNkQPoRjzor3zvfg5x+fpDve28/UOFXb2WoCtY9CyAzUni3wvbFN 3Ha7DOX06sCLotPRzQqY2efj/ZWcbJLOmGdSPtc8tIAlPjMrctcuU83wkGju5mq6 bCENPL8y62ydHtSszP2hVCoHSeUpuDPaUDtSRiE/+GkoG8Xz+ZkLIi/77BAkpj2t tEtiWUem4uxtOxdFmSYPNUNrY7+p7YceqiZVZrV7lvlDWaaidYjvTf/K0nTISYQX CgX4ohf3In+/IPdlphnUUuOwnd0Vk6nd8g9SW/ADowwzFwRRYAvLNWw7BxY/sUQ= =0i5y -----END PGP SIGNATURE----- --jDDe2ilTVJaR8lhF7VmomhsJwJ7PM16vp--