From patchwork Fri Apr 8 13:15:34 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Prasad Joshi X-Patchwork-Id: 694531 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by demeter1.kernel.org (8.14.4/8.14.3) with ESMTP id p38DFcQG005910 for ; Fri, 8 Apr 2011 13:15:38 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756684Ab1DHNPf (ORCPT ); Fri, 8 Apr 2011 09:15:35 -0400 Received: from mail-ww0-f42.google.com ([74.125.82.42]:59214 "EHLO mail-ww0-f42.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756550Ab1DHNPf (ORCPT ); Fri, 8 Apr 2011 09:15:35 -0400 Received: by wwk4 with SMTP id 4so514094wwk.1 for ; Fri, 08 Apr 2011 06:15:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:from:to:cc:subject:date:message-id:x-mailer; bh=DkbkbceWJVCLsUZ1ExS3J1CgxpIdOPiyLN9q6juq9Jg=; b=WG1bSg0/HvSIeoyuK7AJqXY+7nnKd7JDviRPxQsCB8Imxx3kkO6L7D0G3IN5yBQNJL 8b0wKmq2kXLqgI1/633nX942p6p4a3g3T/kutiF03hvIpFRI9Z7Z3QMqPMrV4OIyEyCD D2/xqSUJkTyyVPNmAkM313ECrAwSu+7a2q1+E= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=from:to:cc:subject:date:message-id:x-mailer; b=o6Ex7C/Pho6tl23imXQwo+XaOc84SGRHixgFx8mwQyjqjoo99R3F24Jro7eK8Gg5OB V1bvk30rL6p+NEisejAFNun/Ebpji/BFqzo2HK48fLTUCgwfSaE/OrZnQRi3dQ49Tw8c 4pjEKEMacYY5gXndoaURcJ52hqf6psmbvdND4= Received: by 10.216.69.7 with SMTP id m7mr1894756wed.73.1302268533655; Fri, 08 Apr 2011 06:15:33 -0700 (PDT) Received: from prasad-kvm.localdomain (pineapple.rdg.ac.uk [134.225.206.123]) by mx.google.com with ESMTPS id n52sm1348887wer.24.2011.04.08.06.15.32 (version=TLSv1/SSLv3 cipher=OTHER); Fri, 08 Apr 2011 06:15:32 -0700 (PDT) Received: by prasad-kvm.localdomain (Postfix, from userid 1000) id 3E10D26E006E; Fri, 8 Apr 2011 14:15:38 +0100 (BST) From: Prasad Joshi To: prasadjoshi12@gmail.com Cc: Prasad Joshi , mingo@elte.hu, kvm@vger.kernel.org, penberg@kernel.org, asias.hejun@gmail.com, gorcunov@gmail.com, oswaldo.cadenas@gmail.com Subject: [PATCH v2 kvm tool: 1/4] Generating list of common kvm tool commands Date: Fri, 8 Apr 2011 14:15:34 +0100 Message-Id: <1302268537-10067-1-git-send-email-prasadjoshi124@gmail.com> X-Mailer: git-send-email 1.7.1 Sender: kvm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.2.6 (demeter1.kernel.org [140.211.167.41]); Fri, 08 Apr 2011 13:15:39 +0000 (UTC) - The Documentation/ directory will have a text file for each commmand. The text file should contain the information about the command in manpage format. - command-list.txt: is a list of common commands used with the kvm tool. - util/generate-cmdlist.sh: is a shell script that uses command-list.txt and text files in Documentation/ directory to generate the common-cmds.h file in the include directory. The header file is furthur used to display a usage messgae. Almost the entire script is copied from the tools/perf. Signed-off-by: Prasad Joshi --- tools/kvm/Documentation/kvm-run.txt | 54 +++++++++++++++++++++++++++++++++++ tools/kvm/command-list.txt | 5 +++ tools/kvm/util/generate-cmdlist.sh | 24 +++++++++++++++ 3 files changed, 83 insertions(+), 0 deletions(-) create mode 100644 tools/kvm/Documentation/kvm-run.txt create mode 100644 tools/kvm/command-list.txt create mode 100755 tools/kvm/util/generate-cmdlist.sh diff --git a/tools/kvm/Documentation/kvm-run.txt b/tools/kvm/Documentation/kvm-run.txt new file mode 100644 index 0000000..4288204 --- /dev/null +++ b/tools/kvm/Documentation/kvm-run.txt @@ -0,0 +1,54 @@ +kvm-run(1) +================ + +NAME +---- +kvm-run - Start the virtual machine + +SYNOPSIS +-------- +[verse] +'kvm run' [-k | --kernel ] + [-d | --image ] + +DESCRIPTION +----------- +The command starts a virtual machine. + +OPTIONS +------- +-m:: +--mem=:: + Virtual machine memory size in MiB. + +-p:: +--params:: + Additional kernel command line arguments. + +-i:: +--initrd=:: + Initial RAM disk image. + +-k:: +--kernel=:: + The virtual machine kernel. +-k +--kvm-dev=:: + KVM device file + +-d:: +--image=:: + A disk image file. + +-s:: +--single-step:: Enable single stepping. + +-g:: +--ioport-debug:: Enable ioport debugging. + +-c:: +--enable-virtio-console:: Enable the virtual IO console + +SEE ALSO +-------- +linkkvm: diff --git a/tools/kvm/command-list.txt b/tools/kvm/command-list.txt new file mode 100644 index 0000000..4eaf399 --- /dev/null +++ b/tools/kvm/command-list.txt @@ -0,0 +1,5 @@ +# +# List of known perf commands. +# command name category [deprecated] [common] +# +kvm-run mainporcelain common diff --git a/tools/kvm/util/generate-cmdlist.sh b/tools/kvm/util/generate-cmdlist.sh new file mode 100755 index 0000000..c3fd172 --- /dev/null +++ b/tools/kvm/util/generate-cmdlist.sh @@ -0,0 +1,24 @@ +#!/bin/sh + +echo "/* Automatically generated by $0 */ +struct cmdname_help +{ + char name[16]; + char help[80]; +}; + +static struct cmdname_help common_cmds[] = {" + +sed -n 's/^kvm-\([^ \t]*\).*common/\1/p' command-list.txt | +sort | +while read cmd +do + # TODO following sed command should be fixed + sed -n '/^NAME/,/^kvm-'"$cmd"'/ { + /NAME/d + /--/d + s/.*kvm-'"$cmd"' - \(.*\)/ {"'"$cmd"'", "\1"},/ + p + }' "Documentation/kvm-$cmd.txt" +done +echo "};"