diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-24 17:50:52 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 945c669138a76be18c6b4da4f8f907d2a5cfd83f (patch) | |
tree | cebff3cae5021d4fcceb5aa51fce1c2aead97ed2 /documentation/dev-manual/error-reporting-tool.rst | |
parent | 6fe3143800925463279d0664fc7f3372b53c6c52 (diff) | |
download | poky-945c669138a76be18c6b4da4f8f907d2a5cfd83f.tar.gz |
manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.
So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.
(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/error-reporting-tool.rst')
-rw-r--r-- | documentation/dev-manual/error-reporting-tool.rst | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/documentation/dev-manual/error-reporting-tool.rst b/documentation/dev-manual/error-reporting-tool.rst new file mode 100644 index 0000000000..a2636da37a --- /dev/null +++ b/documentation/dev-manual/error-reporting-tool.rst | |||
@@ -0,0 +1,85 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Using the Error Reporting Tool | ||
4 | ****************************** | ||
5 | |||
6 | The error reporting tool allows you to submit errors encountered during | ||
7 | builds to a central database. Outside of the build environment, you can | ||
8 | use a web interface to browse errors, view statistics, and query for | ||
9 | errors. The tool works using a client-server system where the client | ||
10 | portion is integrated with the installed Yocto Project | ||
11 | :term:`Source Directory` (e.g. ``poky``). | ||
12 | The server receives the information collected and saves it in a | ||
13 | database. | ||
14 | |||
15 | There is a live instance of the error reporting server at | ||
16 | https://errors.yoctoproject.org. | ||
17 | When you want to get help with build failures, you can submit all of the | ||
18 | information on the failure easily and then point to the URL in your bug | ||
19 | report or send an email to the mailing list. | ||
20 | |||
21 | .. note:: | ||
22 | |||
23 | If you send error reports to this server, the reports become publicly | ||
24 | visible. | ||
25 | |||
26 | Enabling and Using the Tool | ||
27 | =========================== | ||
28 | |||
29 | By default, the error reporting tool is disabled. You can enable it by | ||
30 | inheriting the :ref:`report-error <ref-classes-report-error>` | ||
31 | class by adding the following statement to the end of your | ||
32 | ``local.conf`` file in your :term:`Build Directory`:: | ||
33 | |||
34 | INHERIT += "report-error" | ||
35 | |||
36 | By default, the error reporting feature stores information in | ||
37 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. | ||
38 | However, you can specify a directory to use by adding the following to | ||
39 | your ``local.conf`` file:: | ||
40 | |||
41 | ERR_REPORT_DIR = "path" | ||
42 | |||
43 | Enabling error | ||
44 | reporting causes the build process to collect the errors and store them | ||
45 | in a file as previously described. When the build system encounters an | ||
46 | error, it includes a command as part of the console output. You can run | ||
47 | the command to send the error file to the server. For example, the | ||
48 | following command sends the errors to an upstream server:: | ||
49 | |||
50 | $ send-error-report /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt | ||
51 | |||
52 | In the previous example, the errors are sent to a public database | ||
53 | available at https://errors.yoctoproject.org, which is used by the | ||
54 | entire community. If you specify a particular server, you can send the | ||
55 | errors to a different database. Use the following command for more | ||
56 | information on available options:: | ||
57 | |||
58 | $ send-error-report --help | ||
59 | |||
60 | When sending the error file, you are prompted to review the data being | ||
61 | sent as well as to provide a name and optional email address. Once you | ||
62 | satisfy these prompts, the command returns a link from the server that | ||
63 | corresponds to your entry in the database. For example, here is a | ||
64 | typical link: https://errors.yoctoproject.org/Errors/Details/9522/ | ||
65 | |||
66 | Following the link takes you to a web interface where you can browse, | ||
67 | query the errors, and view statistics. | ||
68 | |||
69 | Disabling the Tool | ||
70 | ================== | ||
71 | |||
72 | To disable the error reporting feature, simply remove or comment out the | ||
73 | following statement from the end of your ``local.conf`` file in your | ||
74 | :term:`Build Directory`. | ||
75 | :: | ||
76 | |||
77 | INHERIT += "report-error" | ||
78 | |||
79 | Setting Up Your Own Error Reporting Server | ||
80 | ========================================== | ||
81 | |||
82 | If you want to set up your own error reporting server, you can obtain | ||
83 | the code from the Git repository at :yocto_git:`/error-report-web/`. | ||
84 | Instructions on how to set it up are in the README document. | ||
85 | |||