Bug 1617836 - Create a new category for sanitizer in the doc r=decoder

Move the *san files from fuzzing to sanitizer

Depends on D64072

Differential Revision: https://phabricator.services.mozilla.com/D64407

--HG--
rename : tools/fuzzing/docs/asan.rst => tools/sanitizer/docs/asan.rst
rename : tools/fuzzing/docs/asan_nightly.rst => tools/sanitizer/docs/asan_nightly.rst
extra : moz-landing-system : lando
This commit is contained in:
Sylvestre Ledru 2020-02-27 15:34:12 +00:00
Родитель 6c4c61fc34
Коммит 6f034f2f1c
7 изменённых файлов: 35 добавлений и 4 удалений

Просмотреть файл

@ -30,6 +30,7 @@ categories:
- testing/geckodriver
- web-platform
- tools/fuzzing
- tools/sanitizer
- testing/perfdocs
l10n_doc:
- intl

Просмотреть файл

@ -3,7 +3,9 @@ Fuzzing
.. toctree::
:maxdepth: 1
:hidden:
:glob:
:reversed:
*
@ -168,14 +170,18 @@ below) if your code can be exercised in this way.
The Fuzzing Interface
~~~~~~~~~~~~~~~~~~~~~
**Fuzzing Interface**
The fuzzing interface is glue code living in mozilla-central in order to make it
easier for developers and security researchers to test C/C++ code with either libFuzzer or afl-fuzz.
This interface offers a gtest (C++ unit test) level component based
fuzzing approach and is suitable for anything that could also be
tested/exercised using a gtest. This method is by far the fastest, but
usually limited to testing isolated components that can be instantiated
on this level. Utilizing this method requires you to write a fuzzing
target similar to writing a gtest. This target will automatically be
usable with libFuzzer and AFLFuzz. We offer a `comprehensive
manual <https://developer.mozilla.org/en-US/docs/Mozilla/Testing/Fuzzing_Interface>`__
usable with libFuzzer and AFLFuzz. We offer a :ref:`comprehensive manual <Fuzzing Interface>`
that describes how to write and utilize your own target.
A simple example here is the `SDP parser

Просмотреть файл

@ -53,6 +53,7 @@ codespell:
- tools/fuzzing/docs/
- tools/moztreedocs/
- tools/lint/
- tools/sanitizer/docs/
- tools/tryselect/
exclude:
- tools/lint/test/test_codespell.py

Просмотреть файл

@ -62,6 +62,8 @@ SPHINX_TREES['try'] = 'tryselect/docs'
SPHINX_TREES['fuzzing'] = 'fuzzing/docs'
SPHINX_TREES['sanitizer'] = 'sanitizer/docs'
with Files('tryselect/docs/**'):
SCHEDULES.exclusive = ['docs']

Просмотреть файл

@ -1,5 +1,5 @@
Firefox and Address Sanitizer
=============================
Address Sanitizer
=================
What is Address Sanitizer?
--------------------------

Просмотреть файл

@ -0,0 +1,21 @@
Sanitizer
=========
.. toctree::
:maxdepth: 1
:hidden:
:glob:
*
**Address Sanitizer**
Address Sanitizer (ASan) is a fast memory error detector that detects use-after-free and out-of-bound bugs in C/C++ programs. It uses a compile-time instrumentation to check all reads and writes during the execution. In addition, the runtime part replaces the malloc and free functions to check dynamically allocated memory. More information on how ASan works can be found on the Address Sanitizer wiki.
:ref:`More information <Address Sanitizer>`
**ASan Nightly Project**
The ASan Nightly Project involves building a Firefox Nightly browser with the popular AddressSanitizer tool and enhancing it with remote crash reporting capabilities for any errors detected.
:ref:`More information <ASan Nightly>`