summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml67
-rw-r--r--documentation/ref-manual/ref-classes.xml20
-rw-r--r--documentation/ref-manual/ref-variables.xml25
3 files changed, 112 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 5dced8b608..c11df717d3 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -6988,6 +6988,73 @@
6988 </para> 6988 </para>
6989 </section> 6989 </section>
6990 </section> 6990 </section>
6991
6992 <section id='using-the-error-reporting-tool'>
6993 <title>Using the Error Reporting Tool</title>
6994
6995 <para>
6996 The error reporting tool allows you to
6997 submit errors encountered during builds to a central database.
6998 Outside of the build environment, you can use a web interface to
6999 browse errors, view statistics, and query for errors.
7000 The tool works using a client-server system where the client
7001 portion is integrated with the installed Yocto Project
7002 <link linkend='source-directory'>Source Directory</link>
7003 (e.g. <filename>poky</filename>).
7004 The server receives the information collected and saves it in a
7005 database.
7006 </para>
7007
7008 <para>
7009 By default, the error reporting tool is disabled.
7010 You can enable it by inheriting the
7011 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink>
7012 class by adding the following statement to the end of
7013 your <filename>local.conf</filename> file in your
7014 <link linkend='build-directory'>Build Directory</link>.
7015 <literallayout class='monospaced'>
7016 INHERIT += "report-error"
7017 </literallayout>
7018 To disable the feature, simply remove or comment out the statement.
7019 </para>
7020
7021 <para>
7022 By default, the error reporting feature stores information in
7023 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LOG_DIR'><filename>LOG_DIR</filename></ulink><filename>}/error-report</filename>.
7024 However, you can specify a directory to use by adding the following
7025 to your <filename>local.conf</filename> file:
7026 <literallayout class='monospaced'>
7027 ERR_REPORT_DIR = "path"
7028 </literallayout>
7029 Enabling error reporting causes the build process to collect
7030 the errors and store them in a file as previously described.
7031 When the build system encounters an error, it includes a command
7032 as part of the console output.
7033 You can run the command to send the error file to the server.
7034 For example, the following command sends the errors to an upstream
7035 server:
7036 <literallayout class='monospaced'>
7037 send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server]
7038 </literallayout>
7039 In the above example, the <filename>server</filename> parameter is
7040 optional.
7041 By default, the errors are sent to a database used by the entire
7042 community.
7043 If you specify a particular server, you can send them to a different
7044 database.
7045 </para>
7046
7047 <para>
7048 When sending the error file, you receive a link that corresponds
7049 to your entry in the database.
7050 For example, here is a typical link:
7051 <literallayout class='monospaced'>
7052 http://localhost:8000/Errors/Search/1/158
7053 </literallayout>
7054 Following the link takes you to a web interface where you can
7055 browse, query the errors, and view statistics.
7056 </para>
7057 </section>
6991</chapter> 7058</chapter>
6992 7059
6993<!-- 7060<!--
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
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7d038cb436..13f62f4c9d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1833,6 +1833,31 @@
1833 </glossdef> 1833 </glossdef>
1834 </glossentry> 1834 </glossentry>
1835 1835
1836 <glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm>
1837 <glossdef>
1838 <para>
1839 When used with the
1840 <link linkend='ref-classes-report-error'><filename>report-error</filename></link>
1841 class, specifies the path used for storing the debug files
1842 created by the
1843 <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>,
1844 which allows you to submit build errors you encounter to a
1845 central database.
1846 By default, the value of this variable is
1847 <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>.
1848 </para>
1849
1850 <para>
1851 You can set <filename>ERR_REPORT_DIR</filename> to the path
1852 you want the error reporting tool to store the debug files
1853 as follows in your <filename>local.conf</filename> file:
1854 <literallayout class='monospaced'>
1855 ERR_REPORT_DIR = "path"
1856 </literallayout>
1857 </para>
1858 </glossdef>
1859 </glossentry>
1860
1836 <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> 1861 <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
1837 <glossdef> 1862 <glossdef>
1838 <para> 1863 <para>