summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.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-variables.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-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml25
1 files changed, 25 insertions, 0 deletions
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>