bootchart: merge bootchart

Bootchart is renamed to 'systemd-bootchart' and installed as
/usr/lib/systemd/systemd-bootchart. The configuration file
will reside in /etc/systemd/bootchart.conf.

2 files changed, 275 insertions, 0 deletions

diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml
new file mode 100644
index 0000000000..f8fcfe0103
--- /dev/null
+++ b/man/bootchart.conf.xml
@@ -0,0 +1,158 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2012 Intel Corporation
+
+  Authors:
+    Auke Kok <auke-jan.h.kok@intel.com>
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="bootchart.conf">
+        <refentryinfo>
+                <title>bootchart.conf</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Auke</firstname>
+                                <surname>Kok</surname>
+                                <email>auke-jan.h.kok@intel.com</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>bootchart.conf</refentrytitle>
+                <manvolnum>5</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>bootchart.conf</refname>
+                <refpurpose>Boot performance analysis graphing tool configuration file</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>/etc/systemd/bootchart.conf</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>When starting, systemd-bootchart will read the
+                configuration file <filename>bootchart.conf</filename>.
+                This configuration file determines logging parameters and
+                graph output.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist class='bootchart-directives'>
+
+                        <varlistentry>
+                                <term><varname>samples=500</varname></term>
+                                <listitem><para>Configure the amount of samples to
+                                record total before bootchart exits. Each sample will
+                                record at intervals defined by freq=.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>freq=25</varname></term>
+                                <listitem><para>Configure the sample log frequency.
+                                This can be a fractional number, but must be larger than
+                                0.0. Most systems can cope with values under 25-50 without
+                                impacting boot time severely.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>rel=0</varname></term>
+                                <listitem><para>Configures whether the left axis of the
+                                output graph equals time=0.0 (CLOCK_MONOTONIC start). This
+                                is useful for using bootchart at post-boot time to profile
+                                an already booted system, otherwise the graph would become
+                                extremely large. If set to a non-zero value, the horizontal
+                                axis starts at the first recorded sample instead of time=0.0.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>filter=0</varname></term>
+                                <listitem><para>Configures whether the resulting graph
+                                should omit tasks that did not contribute significantly
+                                to the boot. Processes that are too short-lived (only
+                                seen in one sample) or that do not consume any significant
+                                CPU time (less than 0.001sec) will not be displayed in
+                                the output graph.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>output=[path]</varname></term>
+                                <listitem><para>Configures the output folder for writing
+                                the graphs. By default, bootchart writes the graphs to
+                                <filename>/var/log</filename>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>init=[path]</varname></term>
+                                <listitem><para>Configures bootchart to run a non-standard
+                                binary instead of <filename>/sbin/init</filename>. This
+                                option is only relevant if bootchart was invoked from the
+                                kernel command line with
+                                init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>pss=0</varname></term>
+                                <listitem><para>If set to 1, enables logging and graphing
+                                of processes PSS memory consumption.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>entropy=0</varname></term>
+                                <listitem><para>If set to 1, enables logging and graphing
+                                of the kernel random entropy pool size.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>scale_x=100</varname></term>
+                                <listitem><para>Horizontal scaling factor for all variable
+                                graph components.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>scale_y=20</varname></term>
+                                <listitem><para>Vertical scaling factor for all variable
+                                graph components.</para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                  <title>See Also</title>
+                  <para>
+                          <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                  </para>
+        </refsect1>
+
+</refentry>
diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml
new file mode 100644
index 0000000000..4d53824d46
--- /dev/null
+++ b/man/systemd-bootchart.xml
@@ -0,0 +1,117 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2012 Intel Corporation
+
+  Authors:
+    Auke Kok <auke-jan.h.kok@intel.com>
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd-bootchart">
+        <refentryinfo>
+                <title>systemd-bootchart</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Auke</firstname>
+                                <surname>Kok</surname>
+                                <email>auke-jan.h.kok@intel.com</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>systemd-bootchart</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-bootchart</refname>
+                <refpurpose>Boot performance analysis graphing tool</refpurpose>
+        </refnamediv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>Systemd-bootchart is an boot time analysis tool. It represents
+                various aspects of the system as graph elements. These graph
+                elements allow the user to determine resource usage, efficiency
+                and performance issues.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Invocation</title>
+
+                <para>systemd-bootchart can be invoked in several different ways:</para>
+
+                <variablelist class='bootchart-invocation'>
+
+                        <varlistentry>
+                                <title>Kernel invocation</title>
+                                <listitem><para>The kernel can invoke systemd-bootchart
+                                instead of the init process. In itself, systemd-bootchart
+                                will invoke <filename>/sbin/init</filename> if invoked in
+                                this matter.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <title>Started as a standalone program</title>
+                                <listitem><para>One can execute systemd-bootchart as
+                                normal application from the commandline. In this mode
+                                it is highly recommended to pass the "-r" flag in order
+                                to not graph the time elapsed since boot and before
+                                systemd-bootchart was started, as it may result in
+                                extremely large graphs.
+                                </para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <para>Please read systemd-bootchart --help or the bootchart.conf manual
+                page for information about the various options that influence how
+                systemd-bootchart operates.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Output</title>
+
+                <para>Systemd-bootchart generates SVG graphs. In order to render these
+                on a graphica display any SVG capable viewer can be used. It should be
+                noted that the SVG render engines in most browsers (including Chrome
+                and Firefox) are many times faster than dedicated graphical applications
+                like Gimp and Inkscape.  Just point your browser at "file:///var/log"!
+                </para>
+        </refsect1>
+
+        <refsect1>
+                  <title>See Also</title>
+                  <para>
+                          <citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                  </para>
+        </refsect1>
+
+</refentry>