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: Edits to "Using the Error Reporting Tool"

Browse Source 
Created some sub-section structure to better organize this
section.

(From yocto-docs rev: 61b15f579c4c21378277051bb5905baa4e9741b5)

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-04-17 11:34:32 -07:00
committed by Richard Purdie
parent bf633eba52
commit c4fec0d7ac
1 changed files with 70 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/dev-manual/dev-manual-common-tasks.xml
+70 -49
View File
@@ -7231,62 +7231,83 @@
</note> </note>
</para> </para>
<para> <section id='enabling-and-using-the-tool'>
If you want to set up your own error reporting server, you <title>Enabling and Using the Tool</title>
can obtain the code from the Git repository at
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/'></ulink>.
Instructions on how to set it up are in the README document.
</para>
<para> <para>
By default, the error reporting tool is disabled. By default, the error reporting tool is disabled.
You can enable it by inheriting the You can enable it by inheriting the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink> <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 class by adding the following statement to the end of
your <filename>local.conf</filename> file in your your <filename>local.conf</filename> file in your
<link linkend='build-directory'>Build Directory</link>. <link linkend='build-directory'>Build Directory</link>.
<literallayout class='monospaced'> <literallayout class='monospaced'>
INHERIT += "report-error" INHERIT += "report-error"
</literallayout> </literallayout>
To disable the feature, simply remove or comment out the statement. </para>
</para>
<para> <para>
By default, the error reporting feature stores information in 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>. <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 However, you can specify a directory to use by adding the following
to your <filename>local.conf</filename> file: to your <filename>local.conf</filename> file:
<literallayout class='monospaced'> <literallayout class='monospaced'>
ERR_REPORT_DIR = "path" ERR_REPORT_DIR = "path"
</literallayout> </literallayout>
Enabling error reporting causes the build process to collect Enabling error reporting causes the build process to collect
the errors and store them in a file as previously described. the errors and store them in a file as previously described.
When the build system encounters an error, it includes a command When the build system encounters an error, it includes a command
as part of the console output. as part of the console output.
You can run the command to send the error file to the server. You can run the command to send the error file to the server.
For example, the following command sends the errors to an upstream For example, the following command sends the errors to an upstream
server: server:
<literallayout class='monospaced'> <literallayout class='monospaced'>
send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server] send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server]
</literallayout> </literallayout>
In the above example, the <filename>server</filename> parameter is In the above example, the <filename>server</filename> parameter is
optional. optional.
By default, the errors are sent to a database used by the entire By default, the errors are sent to a database used by the entire
community. community.
If you specify a particular server, you can send them to a different If you specify a particular server, you can send them to a different
database. database.
</para> </para>
<para> <para>
When sending the error file, you receive a link that corresponds When sending the error file, you receive a link that corresponds
to your entry in the database. to your entry in the database.
For example, here is a typical link: For example, here is a typical link:
<literallayout class='monospaced'> <literallayout class='monospaced'>
http://localhost:8000/Errors/Search/1/158 http://localhost:8000/Errors/Search/1/158
</literallayout> </literallayout>
Following the link takes you to a web interface where you can Following the link takes you to a web interface where you can
browse, query the errors, and view statistics. browse, query the errors, and view statistics.
</para> </para>
</section>
<section id='disabling-the-tool'>
<title>Disabling the Tool</title>
<para>
To disable the error reporting feature, simply remove or comment
out the following statement from 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>
</para>
</section>
<section id='setting-up-your-own-error-reporting-server'>
<title>Setting Up Your Own Error Reporting Server</title>
<para>
If you want to set up your own error reporting server, you
can obtain the code from the Git repository at
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/'></ulink>.
Instructions on how to set it up are in the README document.
</para>
</section>
</section> </section>
</chapter> </chapter>