kvm_stat: add kvm_stat.1 man page
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Ademar Reis <areis@redhat.com> Reviewed-by: Wei Huang <wei@redhat.com> Message-Id: <1425338947-10296-3-git-send-email-stefanha@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
parent
9a7dcb711b
commit
811c572776
9
Makefile
9
Makefile
@ -84,6 +84,9 @@ 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-commands.txt
|
||||
ifdef CONFIG_LINUX
|
||||
DOCS+=kvm_stat.1
|
||||
endif
|
||||
ifdef CONFIG_VIRTFS
|
||||
DOCS+=fsdev/virtfs-proxy-helper.1
|
||||
endif
|
||||
@ -490,6 +493,12 @@ qemu-nbd.8: qemu-nbd.texi
|
||||
$(POD2MAN) --section=8 --center=" " --release=" " qemu-nbd.pod > $@, \
|
||||
" GEN $@")
|
||||
|
||||
kvm_stat.1: scripts/kvm/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
|
||||
|
55
scripts/kvm/kvm_stat.texi
Normal file
55
scripts/kvm/kvm_stat.texi
Normal file
@ -0,0 +1,55 @@
|
||||
@example
|
||||
@c man begin SYNOPSIS
|
||||
usage: kvm_stat [OPTION]...
|
||||
@c man end
|
||||
@end example
|
||||
|
||||
@c man begin DESCRIPTION
|
||||
|
||||
kvm_stat prints counts of KVM kernel module trace events. These events signify
|
||||
state transitions such as guest mode entry and exit.
|
||||
|
||||
This tool is useful for observing guest behavior from the host perspective.
|
||||
Often conclusions about performance or buggy behavior can be drawn from the
|
||||
output.
|
||||
|
||||
The set of KVM kernel module trace events may be specific to the kernel version
|
||||
or architecture. It is best to check the KVM kernel module source code for the
|
||||
meaning of events.
|
||||
|
||||
Note that trace events are counted globally across all running guests.
|
||||
|
||||
@c man end
|
||||
|
||||
@c man begin OPTIONS
|
||||
@table @option
|
||||
@item -1, --once, --batch
|
||||
run in batch mode for one second
|
||||
@item -l, --log
|
||||
run in logging mode (like vmstat)
|
||||
@item -t, --tracepoints
|
||||
retrieve statistics from tracepoints
|
||||
@item -d, --debugfs
|
||||
retrieve statistics from debugfs
|
||||
@item -f, --fields=@var{fields}
|
||||
fields to display (regex)
|
||||
@item -h, --help
|
||||
show help message
|
||||
@end table
|
||||
|
||||
@c man end
|
||||
|
||||
@ignore
|
||||
|
||||
@setfilename kvm_stat
|
||||
@settitle Report KVM kernel module event counters.
|
||||
|
||||
@c man begin AUTHOR
|
||||
Stefan Hajnoczi <stefanha@redhat.com>
|
||||
@c man end
|
||||
|
||||
@c man begin SEEALSO
|
||||
perf(1), trace-cmd(1)
|
||||
@c man end
|
||||
|
||||
@end ignore
|
Loading…
Reference in New Issue
Block a user