From 66e465420ff179e30dc46378818a5ffae35a6f81 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 26 Nov 2024 10:36:21 +0100 Subject: [PATCH] Doc: Add info about automatic crash reporting - Sentry sets a file size limit for crash reports - Users are not notified about sending reports or whether it succeeds or fails - Describe the location of the reports - Add a note encouraging users to still report crashes in JIRA Fixes: QTCREATORBUG-32061 Change-Id: I1a5ca5f24463cbad846d55f279f4bd02ec1d61ad Reviewed-by: Eike Ziller --- .../creator-how-to-turn-on-crash-reports.qdoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-turn-on-crash-reports.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-turn-on-crash-reports.qdoc index c35e71e4a0e..2c83a8f0be2 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-to-turn-on-crash-reports.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-turn-on-crash-reports.qdoc @@ -24,6 +24,20 @@ \li Select \uicontrol {Enable crash reporting}. \endlist + Crash reports are sent automatically if they don't exceed the file size + limit that Sentry sets for accepting them. You are not notified about + sending the reports or whether it succeeded or failed. + + \section1 Clear local crash reports + + \QC stores crash reports on the computer in the following directories: + + \list + \li On Windows: \c {%APPDATA%\QtProject\qtcreator\crashpad_reports} + \li On Linux and \macos: + \c {$HOME/.config/QtProject/qtcreator/crashpad_reports} + \endlist + To free up disk space that crash reports reserve on the computer, select \uicontrol {Clear Local Crash Reports}. You can see the size of the crash reports next to the button. @@ -31,5 +45,8 @@ Select \uicontrol ? to view more information about Crashpad and the security policy. + \note The best way to report a crash is to create a bug report and attach a + \e .dmp file or paste the corresponding stack trace to the report. + \sa {Contact Qt} */