summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-26 14:51:38 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-30 10:18:37 +0100
commitf1e9e335ee5f37a037522d5afa60249067432105 (patch)
tree10ec427ef464fa724c8d72f063d11d28a0c339f5 /documentation/ref-manual/ref-classes.xml
parentaa73618df5474f1c51c0c37a32831d04e8435cc9 (diff)
downloadpoky-f1e9e335ee5f37a037522d5afa60249067432105.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual/ref-classes.xml')
-rw-r--r--documentation/ref-manual/ref-classes.xml20
1 files changed, 20 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 4e12fd6168..55ee43ce87 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2515,6 +2515,26 @@
2515 </para> 2515 </para>
2516</section> 2516</section>
2517 2517
2518<section id='ref-classes-report-error'>
2519 <title><filename>report-error.bbclass</filename></title>
2520
2521 <para>
2522 The <filename>report-error</filename> class supports enabling the
2523 <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>,
2524 which allows you to submit build error information to a central
2525 database.
2526 </para>
2527
2528 <para>
2529 The class collects debug information for recipe, recipe version, task,
2530 machine, distro, build system, target system, host distro, branch,
2531 commit, and log.
2532 From the information, report files using a JSON format are created and
2533 stored in
2534 <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>.
2535 </para>
2536</section>
2537
2518<section id='ref-classes-rm-work'> 2538<section id='ref-classes-rm-work'>
2519 <title><filename>rm_work.bbclass</filename></title> 2539 <title><filename>rm_work.bbclass</filename></title>
2520 2540