summaryrefslogtreecommitdiffstats
path: root/doc/kcachegrind
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2012-01-30 12:23:09 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2012-01-30 12:23:09 -0600
commit2020f146a7175288d0aaf15cd91b95e545bbb915 (patch)
tree82574d787cef440ad56a6e818d03e908caf3d07d /doc/kcachegrind
parent53b45e0887a2838628521c6086b48b9b4ffe41a4 (diff)
downloadtdesdk-2020f146a7175288d0aaf15cd91b95e545bbb915.tar.gz
tdesdk-2020f146a7175288d0aaf15cd91b95e545bbb915.zip
Rename ksocket and kcache
Diffstat (limited to 'doc/kcachegrind')
-rw-r--r--doc/kcachegrind/CMakeLists.txt2
-rw-r--r--doc/kcachegrind/index.docbook60
2 files changed, 31 insertions, 31 deletions
diff --git a/doc/kcachegrind/CMakeLists.txt b/doc/kcachegrind/CMakeLists.txt
index 7e7cb518..3b193ed5 100644
--- a/doc/kcachegrind/CMakeLists.txt
+++ b/doc/kcachegrind/CMakeLists.txt
@@ -9,4 +9,4 @@
#
#################################################
-tde_create_handbook( DESTINATION kcachegrind )
+tde_create_handbook( DESTINATION tdecachegrind )
diff --git a/doc/kcachegrind/index.docbook b/doc/kcachegrind/index.docbook
index 85a19160..11caf052 100644
--- a/doc/kcachegrind/index.docbook
+++ b/doc/kcachegrind/index.docbook
@@ -1,12 +1,12 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY kcachegrind '<application>KCachegrind</application>'>
+ <!ENTITY tdecachegrind '<application>KCachegrind</application>'>
<!ENTITY cachegrind "<application>Cachegrind</application>">
<!ENTITY calltree "<application>Calltree</application>">
<!ENTITY callgrind "<application>Callgrind</application>">
<!ENTITY valgrind "<application>Valgrind</application>">
<!ENTITY oprofile "<application>OProfile</application>">
- <!ENTITY kappname "&kcachegrind;">
+ <!ENTITY kappname "&tdecachegrind;">
<!ENTITY package "tdesdk">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
@@ -17,7 +17,7 @@
<book lang="&language;">
<bookinfo>
-<title>The &kcachegrind; Handbook</title>
+<title>The &tdecachegrind; Handbook</title>
<authorgroup>
<author>
@@ -43,7 +43,7 @@
<abstract>
<para>
-&kcachegrind; is a profile data visualization tool, written using the &kde; environment.
+&tdecachegrind; is a profile data visualization tool, written using the &kde; environment.
</para>
</abstract>
@@ -186,14 +186,14 @@ Besides a list of functions sorted according exclusive or inclusive cost metrics
</sect1>
</chapter>
-<chapter id="using-kcachegrind">
-<title>Using &kcachegrind;</title>
+<chapter id="using-tdecachegrind">
+<title>Using &tdecachegrind;</title>
<sect1 id="using-profile">
<title>Generate Data to Visualize</title>
<para>First, one wants to generate performance data by measuring aspects of the
-runtime characteristics of an application, using a profiling tool. &kcachegrind;
+runtime characteristics of an application, using a profiling tool. &tdecachegrind;
itself does not include any profiling tool, but is good in being used together with
&callgrind;, and by using a converter, also can be used to visualize data produced
with &oprofile;. Although the scope of this manual is not to document profiling
@@ -205,8 +205,8 @@ with these tools, the next section provides short quickstart tutorials to get yo
<para>
&callgrind; is available from
-<ulink url="http://kcachegrind.sf.net">
-http://kcachegrind.sf.net</ulink>.
+<ulink url="http://tdecachegrind.sf.net">
+http://tdecachegrind.sf.net</ulink>.
Note that it previously was called &calltree;, but that name was misleading.
</para>
@@ -217,7 +217,7 @@ Most common use is to prefix the command line to start your application with
<blockquote><para><command>callgrind myprogram myargs</command></para></blockquote>
At program termination, a file <filename>callgrind.out.pid</filename> will be
-generated which can be loaded into &kcachegrind;.
+generated which can be loaded into &tdecachegrind;.
</para>
<para>
@@ -234,7 +234,7 @@ callgrind --dump-before=KonqMainWindow::slotReload konqueror </command></para></
This will produce multiple profile data files with an additional
sequential number at the end of the filename. A file without such an
number at the end (only ending in the process PID) will also be produced;
-by loading this file into &kcachegrind;, all others are loaded too, and can
+by loading this file into &tdecachegrind;, all others are loaded too, and can
be seen in the Parts Overview and Parts list.
</para>
@@ -256,14 +256,14 @@ as all actions on the system can be observed; therefore, the following has to be
First, configure the profiling process, using the GUI <command>oprof_start</command> or the
command-line tool opcontrol. Standard configuration should be timer mode (TBS, see introduction). To start the measurement, run
<command>opcontrol -s</command>. Then run the application you are interested in and, afterwards, do a <command>opcontrol -d</command>. This will write out
-the measurement results into files under directory <filename>/var/lib/oprofile/samples/</filename>. To be able to visualize the data in &kcachegrind;, do in an empty directory:
+the measurement results into files under directory <filename>/var/lib/oprofile/samples/</filename>. To be able to visualize the data in &tdecachegrind;, do in an empty directory:
<blockquote><para><command>
opreport -gdf | op2callgrind
</command></para></blockquote>
This will produce a lot of files, one for every program which was running
-on the system. Each one can be loaded into &kcachegrind; on its own.
+on the system. Each one can be loaded into &tdecachegrind; on its own.
</para>
</sect2>
@@ -273,7 +273,7 @@ on the system. Each one can be loaded into &kcachegrind; on its own.
<title>User Interface Basics</title>
<para>
-When starting &kcachegrind; with a profile data file as argument, or after loading one with File/Open, you will see a sidebar containing the function list
+When starting &tdecachegrind; with a profile data file as argument, or after loading one with File/Open, you will see a sidebar containing the function list
at the left; and, on the right the main part, an area with visualizations for
a selected function. This visualization area can be arbitrarily configured to
show multiple visualizations at once.
@@ -297,20 +297,20 @@ A first overview of the runtime characteristics should be given when you select
<para>
To explore the GUI further, in addition to this manual, also have a look at the documentation section on the web site
-<ulink url="http://kcachegrind.sf.net">
-http://kcachegrind.sf.net</ulink>.
+<ulink url="http://tdecachegrind.sf.net">
+http://tdecachegrind.sf.net</ulink>.
Also,
-every widget in &kcachegrind; has <quote>What's this</quote> help.
+every widget in &tdecachegrind; has <quote>What's this</quote> help.
</para>
</sect1>
</chapter>
-<chapter id="kcachegrind-concepts">
+<chapter id="tdecachegrind-concepts">
<title>Basic Concepts</title>
-<para>This chapter explains some concepts of the &kcachegrind;, and
+<para>This chapter explains some concepts of the &tdecachegrind;, and
introduces terms used in the interface.
</para>
@@ -618,8 +618,8 @@ Select such a call information line to activate the call destination.
<chapter id="commands">
<title>Command Reference</title>
-<sect1 id="kcachegrind-mainwindow">
-<title>The main &kcachegrind; window</title>
+<sect1 id="tdecachegrind-mainwindow">
+<title>The main &tdecachegrind; window</title>
<para></para>
<sect2>
@@ -768,14 +768,14 @@ This is most interesting after another profile data file was generated for an al
<qandaentry>
<question>
<para>
-What is &kcachegrind; for? I have no idea.
+What is &tdecachegrind; for? I have no idea.
</para>
</question>
<answer>
<para>
-&kcachegrind; is a helpful at a later stage in software development,
+&tdecachegrind; is a helpful at a later stage in software development,
called Profiling. If you don't develop applications, you don't need
-&kcachegrind;.
+&tdecachegrind;.
</para>
</answer>
</qandaentry>
@@ -896,15 +896,15 @@ users.
<appendix id="installation">
<title>Installation</title>
-<sect1 id="getting-kcachegrind">
-<title>How to obtain &kcachegrind;</title>
+<sect1 id="getting-tdecachegrind">
+<title>How to obtain &tdecachegrind;</title>
<para>
-&kcachegrind; is part of the &package; package of &kde;. For less supported
+&tdecachegrind; is part of the &package; package of &kde;. For less supported
interim releases, &callgrind; and further documentation, see
the homepage at
-<ulink url="http://kcachegrind.sf.net">
-http://kcachegrind.sf.net</ulink>. Look there for
+<ulink url="http://tdecachegrind.sf.net">
+http://tdecachegrind.sf.net</ulink>. Look there for
further installation and compile instructions.
</para>
</sect1>
@@ -913,7 +913,7 @@ further installation and compile instructions.
<title>Requirements</title>
<para>
-In order to successfully use &kcachegrind;, you need &kde; 3.x. For
+In order to successfully use &tdecachegrind;, you need &kde; 3.x. For
generating profile data, &cachegrind; or &calltree;/&callgrind; is recommend.
</para>
</sect1>