summaryrefslogtreecommitdiffstats
path: root/external/poky/documentation/profile-manual
diff options
context:
space:
mode:
authortakeshi_hoshina <takeshi_hoshina@mail.toyota.co.jp>2020-11-02 11:07:33 +0900
committertakeshi_hoshina <takeshi_hoshina@mail.toyota.co.jp>2020-11-02 11:07:33 +0900
commit1c7d6584a7811b7785ae5c1e378f14b5ba0971cf (patch)
treecd70a267a5ef105ba32f200aa088e281fbd85747 /external/poky/documentation/profile-manual
parent4204309872da5cb401cbb2729d9e2d4869a87f42 (diff)
recipes
Diffstat (limited to 'external/poky/documentation/profile-manual')
-rw-r--r--external/poky/documentation/profile-manual/figures/lttngmain0.pngbin120581 -> 0 bytes
-rw-r--r--external/poky/documentation/profile-manual/profile-manual-eclipse-customization.xsl35
-rw-r--r--external/poky/documentation/profile-manual/profile-manual-usage.xml182
-rwxr-xr-x[-rw-r--r--]external/poky/documentation/profile-manual/profile-manual.xml59
4 files changed, 31 insertions, 245 deletions
diff --git a/external/poky/documentation/profile-manual/figures/lttngmain0.png b/external/poky/documentation/profile-manual/figures/lttngmain0.png
deleted file mode 100644
index 5f60113c..00000000
--- a/external/poky/documentation/profile-manual/figures/lttngmain0.png
+++ /dev/null
Binary files differ
diff --git a/external/poky/documentation/profile-manual/profile-manual-eclipse-customization.xsl b/external/poky/documentation/profile-manual/profile-manual-eclipse-customization.xsl
deleted file mode 100644
index a898281f..00000000
--- a/external/poky/documentation/profile-manual/profile-manual-eclipse-customization.xsl
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version='1.0'?>
-<xsl:stylesheet
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns="http://www.w3.org/1999/xhtml"
- xmlns:fo="http://www.w3.org/1999/XSL/Format"
- version="1.0">
-
- <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" />
-
-<!--
-
- <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" />
-
- <xsl:import
- href="http://docbook.sourceforge.net/release/xsl/1.76.1/eclipse/eclipse3.xsl" />
-
--->
-
- <xsl:param name="chunker.output.indent" select="'yes'"/>
- <xsl:param name="chunk.quietly" select="1"/>
- <xsl:param name="chunk.first.sections" select="1"/>
- <xsl:param name="chunk.section.depth" select="10"/>
- <xsl:param name="use.id.as.filename" select="1"/>
- <xsl:param name="ulink.target" select="'_self'" />
- <xsl:param name="base.dir" select="'html/profile-manual/'"/>
- <xsl:param name="html.stylesheet" select="'../book.css'"/>
- <xsl:param name="eclipse.manifest" select="0"/>
- <xsl:param name="create.plugin.xml" select="0"/>
- <xsl:param name="suppress.navigation" select="1"/>
- <xsl:param name="generate.index" select="0"/>
- <xsl:param name="chapter.autolabel" select="1" />
- <xsl:param name="appendix.autolabel">A</xsl:param>
- <xsl:param name="section.autolabel" select="1" />
- <xsl:param name="section.label.includes.component.label" select="1" />
-</xsl:stylesheet>
diff --git a/external/poky/documentation/profile-manual/profile-manual-usage.xml b/external/poky/documentation/profile-manual/profile-manual-usage.xml
index a1b56515..9a4273a0 100644
--- a/external/poky/documentation/profile-manual/profile-manual-usage.xml
+++ b/external/poky/documentation/profile-manual/profile-manual-usage.xml
@@ -2182,7 +2182,7 @@
meta-toolchain
meta-ide-support
- You can also run generated qemu images with a command like 'runqemu qemux86'
+ You can also run generated qemu images with a command like 'runqemu qemux86-64'
</literallayout>
Once you've done that, you can cd to whatever directory
@@ -2350,22 +2350,8 @@
<para>
For this section, we'll assume you've already performed the
basic setup outlined in the General Setup section.
- </para>
-
- <para>
LTTng is run on the target system by ssh'ing to it.
- However, if you want to see the traces graphically,
- install Eclipse as described in section
- "<link linkend='manually-copying-a-trace-to-the-host-and-viewing-it-in-eclipse'>Manually copying a trace to the host and viewing it in Eclipse (i.e. using Eclipse without network support)</link>"
- and follow the directions to manually copy traces to the host and
- view them in Eclipse (i.e. using Eclipse without network support).
</para>
-
- <note>
- Be sure to download and install/run the 'SR1' or later Juno release
- of eclipse e.g.:
- <ulink url='http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/juno/SR1/eclipse-cpp-juno-SR1-linux-gtk-x86_64.tar.gz'>http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/juno/SR1/eclipse-cpp-juno-SR1-linux-gtk-x86_64.tar.gz</ulink>
- </note>
</section>
<section id='collecting-and-viewing-traces'>
@@ -2564,163 +2550,6 @@
</para>
</section>
- <section id='manually-copying-a-trace-to-the-host-and-viewing-it-in-eclipse'>
- <title>Manually copying a trace to the host and viewing it in Eclipse (i.e. using Eclipse without network support)</title>
-
- <para>
- If you already have an LTTng trace on a remote target and
- would like to view it in Eclipse on the host, you can easily
- copy it from the target to the host and import it into
- Eclipse to view it using the LTTng Eclipse plug-in already
- bundled in the Eclipse (Juno SR1 or greater).
- </para>
-
- <para>
- Using the trace we created in the previous section, archive
- it and copy it to your host system:
- <literallayout class='monospaced'>
- root@crownbay:~/lttng-traces# tar zcvf auto-20121015-232120.tar.gz auto-20121015-232120
- auto-20121015-232120/
- auto-20121015-232120/kernel/
- auto-20121015-232120/kernel/metadata
- auto-20121015-232120/kernel/channel0_1
- auto-20121015-232120/kernel/channel0_0
-
- $ scp root@192.168.1.47:lttng-traces/auto-20121015-232120.tar.gz .
- root@192.168.1.47's password:
- auto-20121015-232120.tar.gz 100% 1566KB 1.5MB/s 00:01
- </literallayout>
- Unarchive it on the host:
- <literallayout class='monospaced'>
- $ gunzip -c auto-20121015-232120.tar.gz | tar xvf -
- auto-20121015-232120/
- auto-20121015-232120/kernel/
- auto-20121015-232120/kernel/metadata
- auto-20121015-232120/kernel/channel0_1
- auto-20121015-232120/kernel/channel0_0
- </literallayout>
- We can now import the trace into Eclipse and view it:
- <orderedlist>
- <listitem><para>First, start eclipse and open the
- 'LTTng Kernel' perspective by selecting the following
- menu item:
- <literallayout class='monospaced'>
- Window | Open Perspective | Other...
- </literallayout></para></listitem>
- <listitem><para>In the dialog box that opens, select
- 'LTTng Kernel' from the list.</para></listitem>
- <listitem><para>Back at the main menu, select the
- following menu item:
- <literallayout class='monospaced'>
- File | New | Project...
- </literallayout></para></listitem>
- <listitem><para>In the dialog box that opens, select
- the 'Tracing | Tracing Project' wizard and press
- 'Next>'.</para></listitem>
- <listitem><para>Give the project a name and press
- 'Finish'.</para></listitem>
- <listitem><para>In the 'Project Explorer' pane under
- the project you created, right click on the
- 'Traces' item.</para></listitem>
- <listitem><para>Select 'Import..." and in the dialog
- that's displayed:</para></listitem>
- <listitem><para>Browse the filesystem and find the
- select the 'kernel' directory containing the trace
- you copied from the target
- e.g. auto-20121015-232120/kernel</para></listitem>
- <listitem><para>'Checkmark' the directory in the tree
- that's displayed for the trace</para></listitem>
- <listitem><para>Below that, select 'Common Trace Format:
- Kernel Trace' for the 'Trace Type'</para></listitem>
- <listitem><para>Press 'Finish' to close the dialog
- </para></listitem>
- <listitem><para>Back in the 'Project Explorer' pane,
- double-click on the 'kernel' item for the
- trace you just imported under 'Traces'
- </para></listitem>
- </orderedlist>
- You should now see your trace data displayed graphically
- in several different views in Eclipse:
- </para>
-
- <para>
- <imagedata fileref="figures/lttngmain0.png" width="6in" depth="6in" align="center" scalefit="1" />
- </para>
-
- <para>
- You can access extensive help information on how to use
- the LTTng plug-in to search and analyze captured traces via
- the Eclipse help system:
- <literallayout class='monospaced'>
- Help | Help Contents | LTTng Plug-in User Guide
- </literallayout>
- </para>
- </section>
-
- <section id='collecting-and-viewing-a-trace-in-eclipse'>
- <title>Collecting and viewing a trace in Eclipse</title>
-
- <note>
- This section on collecting traces remotely doesn't currently
- work because of Eclipse 'RSE' connectivity problems. Manually
- tracing on the target, copying the trace files to the host,
- and viewing the trace in Eclipse on the host as outlined in
- previous steps does work however - please use the manual
- steps outlined above to view traces in Eclipse.
- </note>
-
- <para>
- In order to trace a remote target, you also need to add
- a 'tracing' group on the target and connect as a user
- who's part of that group e.g:
- <literallayout class='monospaced'>
- # adduser tomz
- # groupadd -r tracing
- # usermod -a -G tracing tomz
- </literallayout>
- <orderedlist>
- <listitem><para>First, start eclipse and open the
- 'LTTng Kernel' perspective by selecting the following
- menu item:
- <literallayout class='monospaced'>
- Window | Open Perspective | Other...
- </literallayout></para></listitem>
- <listitem><para>In the dialog box that opens, select
- 'LTTng Kernel' from the list.</para></listitem>
- <listitem><para>Back at the main menu, select the
- following menu item:
- <literallayout class='monospaced'>
- File | New | Project...
- </literallayout></para></listitem>
- <listitem><para>In the dialog box that opens, select
- the 'Tracing | Tracing Project' wizard and
- press 'Next>'.</para></listitem>
- <listitem><para>Give the project a name and press
- 'Finish'. That should result in an entry in the
- 'Project' subwindow.</para></listitem>
- <listitem><para>In the 'Control' subwindow just below
- it, press 'New Connection'.</para></listitem>
- <listitem><para>Add a new connection, giving it the
- hostname or IP address of the target system.
- </para></listitem>
- <listitem><para>Provide the username and password
- of a qualified user (a member of the 'tracing' group)
- or root account on the target system.
- </para></listitem>
- <listitem><para>Provide appropriate answers to whatever
- else is asked for e.g. 'secure storage password'
- can be anything you want.
- If you get an 'RSE Error' it may be due to proxies.
- It may be possible to get around the problem by
- changing the following setting:
- <literallayout class='monospaced'>
- Window | Preferences | Network Connections
- </literallayout>
- Switch 'Active Provider' to 'Direct'
- </para></listitem>
- </orderedlist>
- </para>
- </section>
</section>
<section id='lltng-documentation'>
@@ -2742,15 +2571,6 @@
You can find a "Getting Started" link on this site that takes
you to an LTTng Quick Start.
</para>
-
- <para>
- Finally, you can access extensive help information on how to use
- the LTTng plug-in to search and analyze captured traces via the
- Eclipse help system:
- <literallayout class='monospaced'>
- Help | Help Contents | LTTng Plug-in User Guide
- </literallayout>
- </para>
</section>
</section>
diff --git a/external/poky/documentation/profile-manual/profile-manual.xml b/external/poky/documentation/profile-manual/profile-manual.xml
index 02d989ff..3527850d 100644..100755
--- a/external/poky/documentation/profile-manual/profile-manual.xml
+++ b/external/poky/documentation/profile-manual/profile-manual.xml
@@ -22,11 +22,10 @@
<authorgroup>
<author>
- <firstname>Scott</firstname> <surname>Rifenbark</surname>
<affiliation>
- <orgname>Scotty's Documentation Services, INC</orgname>
+ <orgname>&ORGNAME;</orgname>
</affiliation>
- <email>srifenbark@gmail.com</email>
+ <email>&ORGEMAIL;</email>
</author>
</authorgroup>
@@ -34,7 +33,7 @@
<revision>
<revnumber>1.4</revnumber>
<date>April 2013</date>
- <revremark>Released with the Yocto Project 1.4 Release.</revremark>
+ <revremark>The initial document released with the Yocto Project 1.4 Release.</revremark>
</revision>
<revision>
<revnumber>1.5</revnumber>
@@ -42,11 +41,6 @@
<revremark>Released with the Yocto Project 1.5 Release.</revremark>
</revision>
<revision>
- <revnumber>1.5.1</revnumber>
- <date>January 2014</date>
- <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
- </revision>
- <revision>
<revnumber>1.6</revnumber>
<date>April 2014</date>
<revremark>Released with the Yocto Project 1.6 Release.</revremark>
@@ -97,24 +91,29 @@
<revremark>Released with the Yocto Project 2.6 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.1</revnumber>
- <date>February 2019</date>
- <revremark>Released with the Yocto Project 2.6.1 Release.</revremark>
+ <revnumber>2.7</revnumber>
+ <date>May 2019</date>
+ <revremark>Released with the Yocto Project 2.7 Release.</revremark>
+ </revision>
+ <revision>
+ <revnumber>3.0</revnumber>
+ <date>October 2019</date>
+ <revremark>Released with the Yocto Project 3.0 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.2</revnumber>
- <date>April 2019</date>
- <revremark>Released with the Yocto Project 2.6.2 Release.</revremark>
+ <revnumber>3.1</revnumber>
+ <date>April 2020</date>
+ <revremark>Released with the Yocto Project 3.1 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.3</revnumber>
- <date>August 2019</date>
- <revremark>Released with the Yocto Project 2.6.3 Release.</revremark>
+ <revnumber>3.1.1</revnumber>
+ <date>June 2020</date>
+ <revremark>Released with the Yocto Project 3.1.1 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.4</revnumber>
- <date>November 2019</date>
- <revremark>Released with the Yocto Project 2.6.4 Release.</revremark>
+ <revnumber>3.1.2</revnumber>
+ <date>&REL_MONTH_YEAR;</date>
+ <revremark>Released with the Yocto Project 3.1.2 Release.</revremark>
</revision>
</revhistory>
@@ -139,7 +138,7 @@
Yocto Project.
To be sure you have the latest version of the manual
for this release, go to the
- <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
+ <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
and select the manual from that site.
Manuals from the site are more up-to-date than manuals
derived from the Yocto Project released TAR files.
@@ -156,18 +155,20 @@
page.
If you need a version of this manual for a different
Yocto Project release, visit the
- <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>
+ <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink>
and select the manual set by using the
"ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE"
pull-down menus.
</para></listitem>
- <listitem><para>
+ <listitem>
+ <para>
To report any inaccuracies or problems with this
- manual, send an email to the Yocto Project
- discussion group at
- <filename>yocto@yoctoproject.com</filename> or log into
- the freenode <filename>#yocto</filename> channel.
- </para></listitem>
+ (or any other Yocto Project) manual, send an email to
+ the Yocto Project documentation mailing list at
+ <filename>docs@lists.yoctoproject.org</filename> or
+ log into the freenode <filename>#yocto</filename> channel.
+ </para>
+ </listitem>
</itemizedlist>
</note>
</legalnotice>