From 5eb5d19468c2b84d1adfef20d1723c8c7d6289f3 Mon Sep 17 00:00:00 2001 From: Seth Chaiklin Date: Fri, 20 Nov 2020 11:07:27 +0100 Subject: tdf#126492 update help information about Crash Report Tool This patch updates the Error Reporting help to the Crash Report Tool, which was introduced in 2016. The same basic form is used, with details adjusted to correspond to the new tool. Also corrected the name of Windows system tool that collects memory traces. The Crash Report uses Breakpad, a third-party general library, which can be used to customize the minidump sent to crashreport.libreoffice.org. The present patch is constructed partly from some general information about what is collected that appears on Markus Mohrhard's blog [1], the documentation for breakpad (in general)[2], and from looking at actual reports in crashreport.libreoffice.org. Information sources: [1] https://mmohrhard.wordpress.com/2016/06/19/crash-reporting-for-libreoffice/ [2] https://chromium.googlesource.com/breakpad/breakpad/+/master/docs/ Change-Id: I45657601ddc1f1463e8a3e6c93614d154f19b388 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/106230 Tested-by: Jenkins Reviewed-by: Seth Chaiklin Reviewed-by: Adolfo Jayme Barrientos (cherry picked from commit c878f6d6a31245cf2dcebbbf27a17defc3d96660) Reviewed-on: https://gerrit.libreoffice.org/c/help/+/107301 --- source/text/shared/guide/error_report.xhp | 38 +++++++++++++++---------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/source/text/shared/guide/error_report.xhp b/source/text/shared/guide/error_report.xhp index 9f3744a0f1..baba5ba3b9 100644 --- a/source/text/shared/guide/error_report.xhp +++ b/source/text/shared/guide/error_report.xhp @@ -20,7 +20,7 @@ - Error Report Tool + Crash Report Tool /text/shared/guide/error_report.xhp @@ -28,31 +28,31 @@ - Error Report Tool - reports;error reports + Crash Report Tool + reports;crash reports crash reports - activating;Error Report Tool + activating;Crash Report Tool -MW changed "reporting..." to "reports;" -Error Report Tool -The Error Report Tool starts automatically when a program crash occurs.removed sentene about manually - i96770 -The Error Report Tool gathers all necessary information that can help the program developers to improve the code, so that in later versions this error can possibly be avoided. Please help us to improve the software and send the generated error report. +

Crash Report Tool

+The Crash Report Tool starts automatically after a program crash occurs. +The Crash Report Tool gathers necessary information that can help the program developers to improve the code, so that in later versions this error can possibly be avoided. Please help us to improve the software and send the generated crash report. -Starting the Error Report Tool -With most program crashes the Error Report Tool will start automatically. +

Starting the Crash Report Tool

+With most program crashes the Crash Report Tool will start automatically. -Completing the Report -On the main Error Report Tool dialog, you can enter some additional information that may help the developers to localize the error. For example, if the error only appears after a change in your hardware or software environment, or if you clicked on a button, please include that information. +

Sending the Crash Report

+Select the checkbox if you want to restart %PRODUCTNAME in safe mode. Then click the Send Crash Report button. +If a crash report is sent successfully, then a dialog box will provide a URL for the report. To see the report, copy the URL and paste into a webbrowser. -Sending the Error Report -The Error Report Tool uses the HTTP PUT / SOAP protocol to send the report data. You may optionally enter some descriptive text that will help us to identify the context of the program crash. Then click the Send button. -You will not get an answer to your error report. If you need support, please visit the support forum on the Internet. -You may choose to respond to questions that the developers may have about the reported error. Mark the check box if you want to be contacted by email, should additional information be required. By default this box is not marked, so you will not get any email. +You will not get an answer to your crash report. If you need support, please visit Community Assistance for an overview of different possibilities. -What Data is Sent? -The error report consists of several files. The main file contains information about the error type, operating system name and version, memory usage, and the description that you entered. You can click the Show Report button on the main dialog of the Error Report Tool to view what will get sent in the main file. -In addition, relevant memory contents and stack traces are gathered by some system standard tools ("dbhhelp.dll" on Windows systems, "pstack" on UNIX systems). This information will be sent also. +

What Data are Sent?

+The crash report sends information about the error type that caused the crash and the process memory contents at the time of the crash. The memory contents include: a list of loaded libraries and their version number; a list of the current threads with the contents of their stack memory and processor register states. The memory trace is gathered locally by standard system tools: dbghelp.dll on Windows systems; clone(), ptrace() and /proc directory on Linux systems; Apple's Crash Reporter on Mac systems. + +Information is also sent about the %PRODUCTNAME version, the operating system name and version, and the computing hardware (CPU identification; graphics device and driver). + +The crash report is anonymous. No identification information is sent and no document content is sent. The report data are sent as a multipart HTTP POST request. \ No newline at end of file -- cgit