Commit 102a0968 authored by Sylvestre Ledru's avatar Sylvestre Ledru
Browse files

Bug 1665854 - fx doc: Various improvements + configuration + fixes in the doc... 

Bug 1665854 - fx doc: Various improvements + configuration + fixes in the doc r=firefox-build-system-reviewers,rstewart

Depends on D90831

Differential Revision: https://phabricator.services.mozilla.com/D90832
parent cadbbb06

docs/contributing/debugging/debugging_a_minidump.rst

+3 −3
Original line number Diff line number Diff line
@@ -31,9 +31,9 @@ access and where to find minidump files for crash reports, consult the 
Using the MS Visual Studio debugger

-----------------------------------



#. Set up the debugger to `use the Mozilla symbol

   server <https://developer.mozilla.org/en/Using_the_Mozilla_symbol_server>`__ and `source

   server <https://developer.mozilla.org/en-US/docs/Mozilla/Using_the_Mozilla_source_server>`__\.

#. Set up the debugger to :ref:`use the Mozilla symbol

   server <Using The Mozilla Symbol Server>` and

   :ref:`source server <Using The Mozilla Source Server>`.

#. Double-click on the minidump file to open it in the debugger.

#. When it loads, click the green icon in the visual studio debugger

   toolbar that looks like a play button.

docs/contributing/debugging/understanding_crash_reports.rst

+1 −2
Original line number Diff line number Diff line
@@ -317,8 +317,7 @@ See also 
-  `A talk about understanding crash

   reports <https://air.mozilla.org/a-talk-about-understanding-crash-reports/>`__,

   by David Baron, from March 2016.

-  `A guide to searching crash

   reports <https://developer.mozilla.org/en-US/docs/A_guide_to_searching_crash_reports>`__

-  :ref:`A guide to searching crash reports`



.. |Example fields in the "Details" tab of a crash report| image:: https://mdn.mozillademos.org/files/13579/Details1.png

.. |Information relating to bug reports in the "Details" tab of a crash report| image:: https://mdn.mozillademos.org/files/13581/Details2.png

docs/crash-reporting/crash-reporting.rst→docs/crash-reporting/index.rst

+13 −24
Original line number Diff line number Diff line
@@ -20,44 +20,33 @@ Crash data submitted using the Mozilla Crash Reporter is located on 
a specific crash that you submitted, you first need to find the Crash ID

that the server has assigned your crash. Type ``about:crashes`` into

your location bar to get a page listing both submitted and unsubmitted

crash reports. For more information, see `How to get a stacktrace for a

bug report </en-US/docs/How_to_get_a_stacktrace_for_a_bug_report>`__.

crash reports. For more information, see :ref:`How to get a stacktrace for a bug report`.





Reports and queries

-------------------



crash-stats has built-in reports of "topcrashes" for each release

grouped by signature. There is also a custom query tool which allows

users to limit searches on more precise information.

grouped by signature. There is also a `custom query tool <https://crash-stats.mozilla.org/search/>`__

which allows users to limit searches on more precise information.



Finally, a set of Mozilla employees have access to directly query the

underlying data in either SQL summary or using mapreduce on the storage

cluster. If you are interested in obtaining this advanced access,

contact `Gabriele Svelto <mailto:gsvelto@mozilla.com>`__.

cluster. If you are interested in obtaining this advanced access, read

`Crash Stats Documentation: Protected Data Access <https://crash-stats.mozilla.org/documentation/protected_data_access/>`__





See also

--------



-  `Understanding crash

   reports </en-US/docs/Mozilla/Projects/Crash_reporting/Understanding_crash_reports>`__

-  `A guide to searching crash

   reports </en-US/docs/Mozilla/Projects/Crash_reporting/Searching_crash_reports>`__

-  :ref:`Understanding crash reports`

-  :ref:`A guide to searching crash reports`

-  `crash-stats <https://crash-stats.mozilla.com/>`__

-  `Crash pings (Telemetry) and crash reports (Socorro/Crash

   Stats) <https://bluesock.org/~willkg/blog/mozilla/crash_pings_crash_reports.html>`__

-  `Building Firefox with Debug

   Symbols </en-US/docs/Building_Firefox_with_Debug_Symbols>`__

-  `Environment variables affecting crash

   reporting <https://firefox-source-docs.mozilla.org/toolkit/crashreporter/crashreporter/index.html#environment-variables-affecting-crash-reporting>`__

-  `Uploading Symbols to Mozilla's Symbol

   Server </en-US/docs/Uploading_symbols_to_Mozillas_symbol_server>`__

-  In-code documentation



   -  `Crash

      reporter <https://firefox-source-docs.mozilla.org/toolkit/crashreporter/crashreporter/index.html>`__

   -  `Crash

      manager <https://firefox-source-docs.mozilla.org/toolkit/components/crashes/crash-manager/index.html>`__

   -  `Crash

      ping <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/crash-ping.html>`__
 
-  :ref:`Building with Debug Symbols`

-  :ref:`Environment variables affecting crash reporting <Crash Reporter#Environment variables affecting crash reporting>`

-  :ref:`Uploading symbols to Mozilla's symbol server`

-  :ref:`Crash reporter`

-  :ref:`Crash manager`

-  :ref:`Crash ping`

docs/crash-reporting/searching_crash_reports.rst

+3 −3
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ by clicking on the "Super Search" link near the toolbar at the top right 
of any page in crash-stats. This brings up a search form like the one in

the following screenshot.



|Results of a default search in crash-stats|

|Search in crash-stats|



Fields are provided for four common search criteria: product, version,

platform, and process type. The product field is pre-populated with
@@ -246,7 +246,7 @@ documentation <https://crash-stats.mozilla.com/documentation/supersearch/>`__ 
for full details; note that it uses the term "aggregation" for

grouping/faceting.



.. |Results of a default search in crash-stats| image:: img/super-search-form.png

.. |Search in crash-stats| image:: img/super-search-form.png

.. |Results of a default search in crash-stats| image:: img/default-search-results.png

.. |Results of a default search in crash-stats (crash reports tab)| image:: img/default-search-results2.png

.. |crash-stats Super Search form with additional criteria| image:: img/super-search-form2.png

docs/setup/contributing_code.rst

+2 −5
Original line number Diff line number Diff line
@@ -74,12 +74,10 @@ We leave this in your hands. Here are some further resources to help: 
   `https://developer.mozilla.org/docs/Developer_Guide <https://developer.mozilla.org/docs/Developer_Guide>`_

   and its parent document,

   https://developer.mozilla.org/docs/Mozilla

-  Our `reviewer

   checklist <https://developer.mozilla.org/docs/Developer_Guide/Reviewer_Checklist>`_ is very

-  Our :ref:`reviewer checklist <Reviewer_Checklist>` is very

   useful, if you have a patch near completion, and seek a favorable

   review

-  Utilize our build tool

   `Mach <https://developer.mozilla.org/docs/Mozilla/Developer_guide/mach>`_, its linting,

-  Utilize our build tool :ref:`mach`, its linting,

   static analysis, and other code checking features



Getting your code reviewed
@@ -199,4 +197,3 @@ form: 
-  `Mozilla platform development

   cheatsheet <https://web.archive.org/web/20160813112326/http://www.codefirefox.com:80/cheatsheet>`_

   (archive.org)