mrc0mmand / rpms / libguestfs

Forked from rpms/libguestfs 3 years ago
Clone
Blob Blame History Raw
From 72a5b6bd7893c5c955a8c4e1957ac9453c71c285 Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Fri, 1 Apr 2016 17:46:53 +0100
Subject: [PATCH] docs: Link to boot-analysis program from
 guestfs-performance(1).

(cherry picked from commit 2e04be377a71e9e76d7c8483889a717e9d4f8ec9)
---
 docs/guestfs-performance.pod | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/docs/guestfs-performance.pod b/docs/guestfs-performance.pod
index 2a7a4a4..4ba6faf 100644
--- a/docs/guestfs-performance.pod
+++ b/docs/guestfs-performance.pod
@@ -429,7 +429,23 @@ example).
 In Xen, dom0 is a virtual machine, and so hardware virtualization is
 not available.
 
-=head1 DETAILED TIMINGS USING TS
+=head1 DETAILED ANALYSIS
+
+=head2 Boot analysis
+
+In the libguestfs source directory, in F<tests/qemu> is a program
+called C<boot-analysis>.  This program is able to produce a very
+detailed breakdown of the boot steps (eg. qemu, BIOS, kernel,
+libguestfs init script), and can measure how long it takes to perform
+each step.
+
+To run this program, do:
+
+ make
+ make -C tests/qemu boot-analysis
+ ./run ./tests/qemu/boot-analysis
+
+=head2 Detailed timings using ts
 
 Use the L<ts(1)> command (from moreutils) to show detailed
 timings:
@@ -450,7 +466,7 @@ timings:
 
 The timestamps are seconds (incrementally since the previous line).
 
-=head1 DETAILED TIMINGS USING SYSTEMTAP
+=head2 Detailed timings using SystemTap
 
 You can use SystemTap (L<stap(1)>) to get detailed timings from
 libguestfs programs.
@@ -516,7 +532,7 @@ example:
 You will need to consult, and even modify, the source to libguestfs to
 fully understand the output.
 
-=head1 DETAILED DEBUGGING USING GDB
+=head2 Detailed debugging using gdb
 
 You can attach to the appliance BIOS/kernel using gdb.  If you know
 what you're doing, this can be a useful way to diagnose boot
-- 
1.8.3.1