From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43)
	id 1N3ncF-0003YQ-CV
	for qemu-devel@nongnu.org; Fri, 30 Oct 2009 05:17:51 -0400
Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43)
	id 1N3ncA-0003TU-UC
	for qemu-devel@nongnu.org; Fri, 30 Oct 2009 05:17:50 -0400
Received: from [199.232.76.173] (port=41510 helo=monty-python.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.43) id 1N3ncA-0003T6-Nr
	for qemu-devel@nongnu.org; Fri, 30 Oct 2009 05:17:46 -0400
Received: from mx1.redhat.com ([209.132.183.28]:21679)
	by monty-python.gnu.org with esmtp (Exim 4.60)
	(envelope-from <kraxel@redhat.com>) id 1N3ncA-0001nx-7u
	for qemu-devel@nongnu.org; Fri, 30 Oct 2009 05:17:46 -0400
Received: from int-mx08.intmail.prod.int.phx2.redhat.com
	(int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id n9U9HjH9001900
	for <qemu-devel@nongnu.org>; Fri, 30 Oct 2009 05:17:45 -0400
Message-ID: <4AEAAF35.8080808@redhat.com>
Date: Fri, 30 Oct 2009 10:17:41 +0100
From: Gerd Hoffmann <kraxel@redhat.com>
MIME-Version: 1.0
References: <1256832211-14532-2-git-send-email-mbooth@redhat.com>
	<1256835400-16258-1-git-send-email-mbooth@redhat.com>
	<1256835400-16258-2-git-send-email-mbooth@redhat.com>
In-Reply-To: <1256835400-16258-2-git-send-email-mbooth@redhat.com>
Content-Type: text/plain; charset=windows-1252; format=flowed
Content-Transfer-Encoding: 7bit
Subject: [Qemu-devel] Re: [PATCH] Documentation: Add documentation for
	-chardev
List-Id: qemu-devel.nongnu.org
List-Unsubscribe: <http://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/pipermail/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <http://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: Matthew Booth <mbooth@redhat.com>
Cc: qemu-devel@nongnu.org

On 10/29/09 17:56, Matthew Booth wrote:
> +DEFHEADING()
> +
> +DEFHEADING(Character device options:)
> +
> +DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
> +    "-chardev null[,id=id]\n"
> +    "                A void device. This device will not emit any data, and will\n"
> +    "                drop any data it receives.\n"

I'd try to keep this shorter to not bloat the -help text.  Just list the 
options, like this:

-chardev null,id=id
-chardev socket,id=id,path=path[,...]           (unix)
-chardev socket,id=id,port=port[,...]           (tcp)
-chardev udp,...

maybe?  The detailed descriptions are in the man-page.

Oh, and id is *not* optional (would be pointless as you would have no 
way to use the chardev), so it shouldn't be listed in brackets.

> +STEXI
> +
> +The general form of a character device option is:
> +@table @option
> +
> +@item -chardev @var{backend} [,id=@var{id}] [,@var{options}]

Same here.

> +@item -chardev vc [,id=@var{id}]
> +
> +Connect to a QEMU text console. @option{vc} does not take any options.

It takes options for the scren size: width+height (pixels) or cols+rows 
(chars) (see console.c).

Otherwise the patch looks fine.

Thanks for doing this,
   Gerd