diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 119 |
1 files changed, 70 insertions, 49 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 43ac532f84..e9848c3503 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -7231,62 +7231,83 @@ | |||
7231 | </note> | 7231 | </note> |
7232 | </para> | 7232 | </para> |
7233 | 7233 | ||
7234 | <para> | 7234 | <section id='enabling-and-using-the-tool'> |
7235 | If you want to set up your own error reporting server, you | 7235 | <title>Enabling and Using the Tool</title> |
7236 | can obtain the code from the Git repository at | ||
7237 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/'></ulink>. | ||
7238 | Instructions on how to set it up are in the README document. | ||
7239 | </para> | ||
7240 | 7236 | ||
7241 | <para> | 7237 | <para> |
7242 | By default, the error reporting tool is disabled. | 7238 | By default, the error reporting tool is disabled. |
7243 | You can enable it by inheriting the | 7239 | You can enable it by inheriting the |
7244 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink> | 7240 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink> |
7245 | class by adding the following statement to the end of | 7241 | class by adding the following statement to the end of |
7246 | your <filename>local.conf</filename> file in your | 7242 | your <filename>local.conf</filename> file in your |
7247 | <link linkend='build-directory'>Build Directory</link>. | 7243 | <link linkend='build-directory'>Build Directory</link>. |
7248 | <literallayout class='monospaced'> | 7244 | <literallayout class='monospaced'> |
7249 | INHERIT += "report-error" | 7245 | INHERIT += "report-error" |
7250 | </literallayout> | 7246 | </literallayout> |
7251 | To disable the feature, simply remove or comment out the statement. | 7247 | </para> |
7252 | </para> | ||
7253 | 7248 | ||
7254 | <para> | 7249 | <para> |
7255 | By default, the error reporting feature stores information in | 7250 | By default, the error reporting feature stores information in |
7256 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LOG_DIR'><filename>LOG_DIR</filename></ulink><filename>}/error-report</filename>. | 7251 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LOG_DIR'><filename>LOG_DIR</filename></ulink><filename>}/error-report</filename>. |
7257 | However, you can specify a directory to use by adding the following | 7252 | However, you can specify a directory to use by adding the following |
7258 | to your <filename>local.conf</filename> file: | 7253 | to your <filename>local.conf</filename> file: |
7259 | <literallayout class='monospaced'> | 7254 | <literallayout class='monospaced'> |
7260 | ERR_REPORT_DIR = "path" | 7255 | ERR_REPORT_DIR = "path" |
7261 | </literallayout> | 7256 | </literallayout> |
7262 | Enabling error reporting causes the build process to collect | 7257 | Enabling error reporting causes the build process to collect |
7263 | the errors and store them in a file as previously described. | 7258 | the errors and store them in a file as previously described. |
7264 | When the build system encounters an error, it includes a command | 7259 | When the build system encounters an error, it includes a command |
7265 | as part of the console output. | 7260 | as part of the console output. |
7266 | You can run the command to send the error file to the server. | 7261 | You can run the command to send the error file to the server. |
7267 | For example, the following command sends the errors to an upstream | 7262 | For example, the following command sends the errors to an upstream |
7268 | server: | 7263 | server: |
7269 | <literallayout class='monospaced'> | 7264 | <literallayout class='monospaced'> |
7270 | send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server] | 7265 | send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server] |
7271 | </literallayout> | 7266 | </literallayout> |
7272 | In the above example, the <filename>server</filename> parameter is | 7267 | In the above example, the <filename>server</filename> parameter is |
7273 | optional. | 7268 | optional. |
7274 | By default, the errors are sent to a database used by the entire | 7269 | By default, the errors are sent to a database used by the entire |
7275 | community. | 7270 | community. |
7276 | If you specify a particular server, you can send them to a different | 7271 | If you specify a particular server, you can send them to a different |
7277 | database. | 7272 | database. |
7278 | </para> | 7273 | </para> |
7279 | 7274 | ||
7280 | <para> | 7275 | <para> |
7281 | When sending the error file, you receive a link that corresponds | 7276 | When sending the error file, you receive a link that corresponds |
7282 | to your entry in the database. | 7277 | to your entry in the database. |
7283 | For example, here is a typical link: | 7278 | For example, here is a typical link: |
7284 | <literallayout class='monospaced'> | 7279 | <literallayout class='monospaced'> |
7285 | http://localhost:8000/Errors/Search/1/158 | 7280 | http://localhost:8000/Errors/Search/1/158 |
7286 | </literallayout> | 7281 | </literallayout> |
7287 | Following the link takes you to a web interface where you can | 7282 | Following the link takes you to a web interface where you can |
7288 | browse, query the errors, and view statistics. | 7283 | browse, query the errors, and view statistics. |
7289 | </para> | 7284 | </para> |
7285 | </section> | ||
7286 | |||
7287 | <section id='disabling-the-tool'> | ||
7288 | <title>Disabling the Tool</title> | ||
7289 | |||
7290 | <para> | ||
7291 | To disable the error reporting feature, simply remove or comment | ||
7292 | out the following statement from the end of your | ||
7293 | <filename>local.conf</filename> file in your | ||
7294 | <link linkend='build-directory'>Build Directory</link>. | ||
7295 | <literallayout class='monospaced'> | ||
7296 | INHERIT += "report-error" | ||
7297 | </literallayout> | ||
7298 | </para> | ||
7299 | </section> | ||
7300 | |||
7301 | <section id='setting-up-your-own-error-reporting-server'> | ||
7302 | <title>Setting Up Your Own Error Reporting Server</title> | ||
7303 | |||
7304 | <para> | ||
7305 | If you want to set up your own error reporting server, you | ||
7306 | can obtain the code from the Git repository at | ||
7307 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/'></ulink>. | ||
7308 | Instructions on how to set it up are in the README document. | ||
7309 | </para> | ||
7310 | </section> | ||
7290 | </section> | 7311 | </section> |
7291 | </chapter> | 7312 | </chapter> |
7292 | 7313 | ||