[Bf-docboard-svn] bf-manual: [7069] trunk/blender_docs/manual/troubleshooting/crash.rst: Add debug logging info to crash docs

[Aaron Carlisle]

Revision: 7069
          https://developer.blender.org/rBM7069
Author:   Blendify
Date:     2020-09-10 02:17:30 +0200 (Thu, 10 Sep 2020)
Log Message:
-----------
Add debug logging info to crash docs

Often times on the bug tracker, this info is repeated.
It should be good to have it in the manual.

Author: @ankitm

Differential Revision: https://developer.blender.org/D8806

Modified Paths:
--------------
    trunk/blender_docs/manual/troubleshooting/crash.rst

Modified: trunk/blender_docs/manual/troubleshooting/crash.rst
===================================================================
--- trunk/blender_docs/manual/troubleshooting/crash.rst	2020-09-09 00:04:17 UTC (rev 7068)
+++ trunk/blender_docs/manual/troubleshooting/crash.rst	2020-09-10 00:17:30 UTC (rev 7069)
@@ -11,8 +11,9 @@
 
 Firstly, you may be able to recover your work with :menuselection:`File --> Recover --> Auto Save...`.
 
-To prevent the problem from happening again, you can check that the graphics drivers are up to date, upgrade your
-machine's hardware (the RAM or graphics card), and disable some options that are more memory intensive:
+To prevent the problem from happening again, you can check that the graphics drivers are up to date
+(:ref:`troubleshooting-gpu-index`), upgrade your machine's hardware (the RAM or graphics card),
+and disable some options that are more memory intensive:
 
 - Reduce undo steps
   :menuselection:`Preferences --> System --> Memory & Limits --> Undo Steps`.
@@ -21,22 +22,54 @@
   (e.g. window shadows and transparency) that are using up the memory that Blender needs.
   Try disabling the desktop effects or switch to a lightweight Window Manager.
 
+To check memory usage by Blender:
 
+- On Windows, use Task Manager and sort by Memory.
+- On macOS, use Activity Monitor.app and open Memory tab. Alternatively, run ``top -o MEM``.
+- On Linux, run ``top -o %MEM``.
+
+
 Crash Log
 =========
 
-When Blender crashes, it writes out a text file
-which contains information that may help identify the cause of the crash.
+When Blender crashes, it writes out a text file which contains information that may help
+identify the cause of the crash. Usually, this file is written in the :ref:`temp-dir` directory.
 
+This file contains a log of tools used up until the crash as well as some other debug information.
+When reporting bugs about crashes it can be helpful to attach this file to your reports,
+especially when others are unable to reproduce the crash.
+
+
+Windows
+-------
+
 On a crash, a file is written based on the name of the currently loaded blend-file,
 so ``test.blend`` will create a file called ``test.crash.txt``.
-The crash log for unsaved files will be written into the :ref:`temp-dir` directory.
 
-This file contains a log of tools used up until the crash as well as some other debug information.
+Batch scripts are provided in Blender installation directory which may be run to obtain
+blender debug log and system info text files:
 
-When reporting bugs on crashes it can be helpful to attach this file to your reports,
-especially when others are unable to reproduce the crash.
+- ``blender_debug_log.cmd`` is used in most cases.
+- ``blender_debug_gpu.cmd`` and ``blender_debug_gpu_workaround.cmd`` log GPU-related errors.
+- ``blender_factory_startup.cmd`` starts Blender with default settings which is recommended for debugging.
 
-.. warning::
+If the crash happens in Blender module, stack trace is also written to a file named ``blender.crash.txt``.
+The path to that file can be found at the end of ``blender_debug_log.txt`` file.
 
-   This is currently disabled for Windows.
+
+macOS
+-----
+
+After crash, macOS Crash Reporter shows a window after some time, or next time Blender is opened. Copy
+the text in the crash report and save it in a text file. That file should be attached to the bug report.
+
+
+Linux
+-----
+
+On a crash, a file named ``blender.crash.txt`` is written in ``/tmp`` directory.
+
+.. note::
+
+   More logs can be obtained by running Blender from Command Line and using ``--factory-startup --debug-all`` flags.
+   See :ref:`command_line-launch-index` and :ref:`command_line-args`.