summaryrefslogtreecommitdiffstats
path: root/toolkit/components/crashes/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/crashes/docs/index.rst')
-rw-r--r--toolkit/components/crashes/docs/index.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/toolkit/components/crashes/docs/index.rst b/toolkit/components/crashes/docs/index.rst
new file mode 100644
index 0000000000..9554a3a8f2
--- /dev/null
+++ b/toolkit/components/crashes/docs/index.rst
@@ -0,0 +1,29 @@
+.. _crashes_crashmanager:
+
+=============
+Crash Manager
+=============
+
+The **Crash Manager** is a service and interface for managing crash
+data within the Gecko application.
+
+From JavaScript, the service can be accessed via::
+
+ let crashManager = Services.crashmanager;
+
+That will give you an instance of ``CrashManager`` from ``CrashManager.jsm``.
+From there, you can access and manipulate crash data.
+
+The crash manager stores statistical information about crashes as well as
+detailed information for both browser and content crashes. The crash manager
+automatically detects new browser crashes at startup by scanning for
+:ref:`Crash Events`. Content process crash information on the other hand is
+provided externally.
+
+Other Documents
+===============
+
+.. toctree::
+ :maxdepth: 1
+
+ crash-events