mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 13:09:50 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-classes.xml
+20
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>
documentation/ref-manual/ref-variables.xml
+25
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>