From patchwork Tue Aug 28 06:24:05 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bo Yang X-Patchwork-Id: 180336 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 839662C0087 for ; Tue, 28 Aug 2012 16:23:58 +1000 (EST) Received: from localhost ([::1]:45455 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1T6FDQ-0001Kp-Ia for incoming@patchwork.ozlabs.org; Tue, 28 Aug 2012 02:23:56 -0400 Received: from eggs.gnu.org ([208.118.235.92]:35532) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1T6FD2-0001Fd-AO for qemu-devel@nongnu.org; Tue, 28 Aug 2012 02:23:46 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1T6FCn-0006s6-MK for qemu-devel@nongnu.org; Tue, 28 Aug 2012 02:23:32 -0400 Received: from mail-we0-f173.google.com ([74.125.82.173]:61872) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1T6FCn-0006rd-Fa for qemu-devel@nongnu.org; Tue, 28 Aug 2012 02:23:17 -0400 Received: by weyz53 with SMTP id z53so2660126wey.4 for ; Mon, 27 Aug 2012 23:23:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:subject:date:message-id:x-mailer; bh=UlKJgeYQayVYgvovEIJFEtIfBCyf7HykKjIsm3zh48Q=; b=PllJPswl9Zmwzbtw+twvytqxtyLOVklU6+UxaVg4AGbTrSXTZegiNjPYK+wQxfinEi Mqcg7ddyRabuX0RqAsa2UnDP2u/+5FWeavOjKekxHhtnD5yJROlg6xn5Pdi80NweaqUh SwU91gnQB9h89czIQjyAXc0naV75QlpVCm8miDNodedBLVoPhuTZPUN9FaglHgm96x25 YrPED5x80CETR8TuyArbHBwCpsBlh91KuyCIOfaAC7jjZ8MUHpk5dPsYtGWcve5NYv9s ea7rXFcJLaGrS6brtQZIIe5GeldrrTFHJajUkSDMM2AWSWSHn1oTI5vXBERVpJXJn8te nYpA== Received: by 10.180.97.106 with SMTP id dz10mr30534948wib.21.1346134996512; Mon, 27 Aug 2012 23:23:16 -0700 (PDT) Received: from localhost.localdomain ([222.126.194.154]) by mx.google.com with ESMTPS id w7sm3299032wiz.0.2012.08.27.23.23.13 (version=TLSv1/SSLv3 cipher=OTHER); Mon, 27 Aug 2012 23:23:15 -0700 (PDT) From: Bo Yang To: qemu-devel@nongnu.org Date: Tue, 28 Aug 2012 14:24:05 +0800 Message-Id: <1346135045-6058-1-git-send-email-boyang@suse.com> X-Mailer: git-send-email 1.6.0.2 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 74.125.82.173 Subject: [Qemu-devel] [PATCH] Documentation for kvm_stat. X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Signed-off-by: Bo Yang --- Makefile | 9 ++++++++- kvm_stat.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletions(-) create mode 100644 kvm_stat.texi diff --git a/Makefile b/Makefile index 1cd5bc8..ee524b0 100644 --- a/Makefile +++ b/Makefile @@ -40,7 +40,7 @@ LIBS+=-lz $(LIBS_TOOLS) HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF) ifdef BUILD_DOCS -DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 QMP/qmp-commands.txt +DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 kvm_stat.1 QMP/qmp-commands.txt ifdef CONFIG_VIRTFS DOCS+=fsdev/virtfs-proxy-helper.1 endif @@ -283,6 +283,7 @@ ifdef CONFIG_POSIX $(INSTALL_DATA) qemu.1 qemu-img.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" $(INSTALL_DATA) qemu-nbd.8 "$(DESTDIR)$(mandir)/man8" + $(INSTALL_DATA) kvm_stat.1 "$(DESTDIR)$(mandir)/man1" endif ifdef CONFIG_VIRTFS $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" @@ -387,6 +388,12 @@ qemu-nbd.8: qemu-nbd.texi $(POD2MAN) --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \ " GEN $@") +kvm_stat.1: kvm_stat.texi + $(call quiet-command, \ + perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< kvm_stat.pod && \ + $(POD2MAN) --section=1 --center=" " --release=" " kvm_stat.pod > $@, \ + " GEN $@") + dvi: qemu-doc.dvi qemu-tech.dvi html: qemu-doc.html qemu-tech.html info: qemu-doc.info qemu-tech.info diff --git a/kvm_stat.texi b/kvm_stat.texi new file mode 100644 index 0000000..ff7d414 --- /dev/null +++ b/kvm_stat.texi @@ -0,0 +1,55 @@ +@example +@c man begin SYNOPSIS + +usage: kvm_stat [OPTIONS] + +@c man end +@end example + +@c man begin DESCRIPTION + +This is a utility to watch kvm statistics. + +@c man end +@c man begin OPTIONS + +@table @option + +@item -h, --help + +Show help message. + +@item -1, --once, --batch + +Run in batch mode for one second. + +@item -l, --log + +Run in logging mode (like vmstat). + +@item -f @var{FIELDS}, --fields=@var{FIELDS} + +Fields to display (regex). regex expression can be accepted here. Fields include: +@samp{size}, @samp{config}, @samp{sample_freq}, @samp{sample_type}, @samp{read_format}, @samp{flags}, @samp{wakeup_events}, @samp{bp_type}, @samp{bp_addr}, @samp{bp_len} + +@end table +@c man end + +@ignore + +@setfilename kvm_stat +@settitle kvm statistics utility + +@c man begin SEE ALSO + +vmstat + +@c man end + +@c man begin AUTHOR + +Copyright (C) 2012 Bo Yang . +This is free software; see the source for copying conditions. There is NO +warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +@c man end +@end ignore