sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual, ref-manual: Added error reporting tool information 

Fixes [YOCTO #1562]

In the dev-manual, I created a new section called "Using the
Error Reporting Tool" that describes how to use this feature.
The text was based on information I received from Andreea Proca.

In the ref-manual, I added a new variable entry for ERR_REPORT_DIR
in the glossary and a new report-error class in the class chapter.

(From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-03-26 14:51:38 -06:00 committed by Richard Purdie
parent aa73618df5
commit f1e9e335ee
3 changed files with 112 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -6988,6 +6988,73 @@
</para>
</section>
</section>
<section id='using-the-error-reporting-tool'>
<title>Using the Error Reporting Tool</title>
<para>
The error reporting tool allows you to
submit errors encountered during builds to a central database.
Outside of the build environment, you can use a web interface to
browse errors, view statistics, and query for errors.
The tool works using a client-server system where the client
portion is integrated with the installed Yocto Project
<link linkend='source-directory'>Source Directory</link>
(e.g. <filename>poky</filename>).
The server receives the information collected and saves it in a
database.
</para>
<para>
By default, the error reporting tool is disabled.
You can enable it by inheriting the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink>
class by adding the following statement to the end of
your <filename>local.conf</filename> file in your
<link linkend='build-directory'>Build Directory</link>.
<literallayout class='monospaced'>
INHERIT += "report-error"
</literallayout>
To disable the feature, simply remove or comment out the statement.
</para>
<para>
By default, the error reporting feature stores information in
<filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LOG_DIR'><filename>LOG_DIR</filename></ulink><filename>}/error-report</filename>.
However, you can specify a directory to use by adding the following
to your <filename>local.conf</filename> file:
<literallayout class='monospaced'>
ERR_REPORT_DIR = "path"
</literallayout>
Enabling error reporting causes the build process to collect
the errors and store them in a file as previously described.
When the build system encounters an error, it includes a command
as part of the console output.
You can run the command to send the error file to the server.
For example, the following command sends the errors to an upstream
server:
<literallayout class='monospaced'>
send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server]
</literallayout>
In the above example, the <filename>server</filename> parameter is
optional.
By default, the errors are sent to a database used by the entire
community.
If you specify a particular server, you can send them to a different
database.
</para>
<para>
When sending the error file, you receive a link that corresponds
to your entry in the database.
For example, here is a typical link:
<literallayout class='monospaced'>
http://localhost:8000/Errors/Search/1/158
</literallayout>
Following the link takes you to a web interface where you can
browse, query the errors, and view statistics.
</para>
</section>
</chapter>
<!--

20
documentation/ref-manual/ref-classes.xml
View File

@ -2515,6 +2515,26 @@
</para>
</section>
<section id='ref-classes-report-error'>
<title><filename>report-error.bbclass</filename></title>
<para>
The <filename>report-error</filename> class supports enabling the
<ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>,
which allows you to submit build error information to a central
database.
</para>
<para>
The class collects debug information for recipe, recipe version, task,
machine, distro, build system, target system, host distro, branch,
commit, and log.
From the information, report files using a JSON format are created and
stored in
<filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>.
</para>
</section>
<section id='ref-classes-rm-work'>
<title><filename>rm_work.bbclass</filename></title>

25
documentation/ref-manual/ref-variables.xml
View File

@ -1833,6 +1833,31 @@
</glossdef>
</glossentry>
<glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm>
<glossdef>
<para>
When used with the
<link linkend='ref-classes-report-error'><filename>report-error</filename></link>
class, specifies the path used for storing the debug files
created by the
<ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>,
which allows you to submit build errors you encounter to a
central database.
By default, the value of this variable is
<filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>.
</para>
<para>
You can set <filename>ERR_REPORT_DIR</filename> to the path
you want the error reporting tool to store the debug files
as follows in your <filename>local.conf</filename> file:
<literallayout class='monospaced'>
ERR_REPORT_DIR = "path"
</literallayout>
</para>
</glossdef>
</glossentry>
<glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
<glossdef>
<para>