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 @@ - - If you want to set up your own error reporting server, you - can obtain the code from the Git repository at - . - Instructions on how to set it up are in the README document. - +
+ Enabling and Using the Tool - - By default, the error reporting tool is disabled. - You can enable it by inheriting the - report-error - class by adding the following statement to the end of - your local.conf file in your - Build Directory. - + + By default, the error reporting tool is disabled. + You can enable it by inheriting the + report-error + class by adding the following statement to the end of + your local.conf file in your + Build Directory. + INHERIT += "report-error" - - To disable the feature, simply remove or comment out the statement. - + + - - By default, the error reporting feature stores information in - ${LOG_DIR}/error-report. - However, you can specify a directory to use by adding the following - to your local.conf file: - + + By default, the error reporting feature stores information in + ${LOG_DIR}/error-report. + However, you can specify a directory to use by adding the following + to your local.conf file: + ERR_REPORT_DIR = "path" - - Enabling error reporting causes the build process to collect - the errors and store them in a file as previously described. - When the build system encounters an error, it includes a command - as part of the console output. - You can run the command to send the error file to the server. - For example, the following command sends the errors to an upstream - server: - + + Enabling error reporting causes the build process to collect + the errors and store them in a file as previously described. + When the build system encounters an error, it includes a command + as part of the console output. + You can run the command to send the error file to the server. + For example, the following command sends the errors to an upstream + server: + send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt [server] - - In the above example, the server parameter is - optional. - By default, the errors are sent to a database used by the entire - community. - If you specify a particular server, you can send them to a different - database. - + + In the above example, the server parameter is + optional. + By default, the errors are sent to a database used by the entire + community. + If you specify a particular server, you can send them to a different + database. + - - When sending the error file, you receive a link that corresponds - to your entry in the database. - For example, here is a typical link: - + + When sending the error file, you receive a link that corresponds + to your entry in the database. + For example, here is a typical link: + http://localhost:8000/Errors/Search/1/158 - - Following the link takes you to a web interface where you can - browse, query the errors, and view statistics. - + + Following the link takes you to a web interface where you can + browse, query the errors, and view statistics. + +
+ +
+ Disabling the Tool + + + To disable the error reporting feature, simply remove or comment + out the following statement from the end of your + local.conf file in your + Build Directory. + + INHERIT += "report-error" + + +
+ +
+ Setting Up Your Own Error Reporting Server + + + If you want to set up your own error reporting server, you + can obtain the code from the Git repository at + . + Instructions on how to set it up are in the README document. + +