From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33778) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fkUZ9-0005Jt-QF for qemu-devel@nongnu.org; Tue, 31 Jul 2018 09:19:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fkUZ8-0006Ac-Si for qemu-devel@nongnu.org; Tue, 31 Jul 2018 09:19:55 -0400 Content-Type: text/plain; charset=us-ascii Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) From: Programmingkid In-Reply-To: Date: Tue, 31 Jul 2018 09:19:47 -0400 Content-Transfer-Encoding: quoted-printable Message-Id: <72B2750F-FD32-4BE3-A8B9-7D046630DFF1@gmail.com> References: <20180731025231.17482-1-programmingkidx@gmail.com> Subject: Re: [Qemu-devel] [PATCH] qemu-img-cmds.hx: Add example usage for create command List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: kwolf@redhat.com, qemu-block@nongnu.org, mreitz@redhat.com, qemu-devel@nongnu.org > On Jul 31, 2018, at 7:57 AM, Eric Blake wrote: >=20 > On 07/30/2018 09:52 PM, John Arbuckle wrote: >> Add an example on how to use the create command. I believe this will = make qemu-img easier to use. >> Signed-off-by: John Arbuckle >> --- >> qemu-img-cmds.hx | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx >> index 69758fb6e8..92f7437944 100644 >> --- a/qemu-img-cmds.hx >> +++ b/qemu-img-cmds.hx >> @@ -50,7 +50,7 @@ STEXI >> ETEXI >> DEF("create", img_create, >> - "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F = backing_fmt] [-u] [-o options] filename [size]") >> + "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F = backing_fmt] [-u] [-o options] filename [size]\nExample: qemu-img create = -f qcow2 WindowsXP.qcow2 10G") >=20 > Making a long line longer. It would be worth using C string = concatenation and splitting this over two lines, at the \n. Sounds like a good idea. > Using the name WindowsXP.qcow2 as the guest is somewhat misleading = (that OS is proprietary, and quickly reaching the point of obsolescence = from its vendor - furthermore, qemu-img doesn't actually install an OS, = but rather creates a blank image for a later install process to = utilize); better would be a generic name that won't go out of date, such = 'image.qcow2'. I always felt a concrete example was easier to understand rather than a = generic example. What about this:=20 Example: qemu-img create -f qcow2 .qcow2 10G >=20 >> STEXI >> @item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b = @var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] = @var{filename} [@var{size}] >> ETEXI >=20 > --=20 > Eric Blake, Principal Software Engineer > Red Hat, Inc. +1-919-301-3266 > Virtualization: qemu.org | libvirt.org