From 0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 03:47:29 +0200
Subject: Adding upstream version 115.8.0esr.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs/code-quality/index.rst | 185 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 185 insertions(+)
 create mode 100644 docs/code-quality/index.rst

(limited to 'docs/code-quality/index.rst')

diff --git a/docs/code-quality/index.rst b/docs/code-quality/index.rst
new file mode 100644
index 0000000000..e8336b7948
--- /dev/null
+++ b/docs/code-quality/index.rst
@@ -0,0 +1,185 @@
+Code quality
+============
+
+Because Firefox is a complex piece of software, a lot of tools are
+executed to identify issues at development phase.
+In this document, we try to list these all tools.
+
+
+.. toctree::
+  :maxdepth: 1
+  :glob:
+
+  static-analysis/index.rst
+  lint/index.rst
+  coding-style/index.rst
+
+.. list-table:: C/C++
+   :header-rows: 1
+   :widths: 20 20 20 20 20
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - Custom clang checker
+     -
+     -
+     - `Source <https://searchfox.org/mozilla-central/source/build/clang-plugin>`_
+     -
+   * - Clang-Tidy
+     - Yes
+     - `bug 712350 <https://bugzilla.mozilla.org/show_bug.cgi?id=712350>`__
+     - :ref:`Static analysis <Static Analysis>`
+     - https://clang.llvm.org/extra/clang-tidy/checks/list.html
+   * - Clang analyzer
+     -
+     - `bug 712350 <https://bugzilla.mozilla.org/show_bug.cgi?id=712350>`__
+     -
+     - https://clang-analyzer.llvm.org/
+   * - cpp virtual final
+     -
+     -
+     - :ref:`cpp virtual final`
+     -
+   * - Semmle/LGTM
+     -
+     - `bug 1458117 <https://bugzilla.mozilla.org/show_bug.cgi?id=1458117>`__
+     -
+     -
+   * - clang-format
+     - Yes
+     - `bug 1188202 <https://bugzilla.mozilla.org/show_bug.cgi?id=1188202>`__
+     - :ref:`Formatting C++ Code With clang-format`
+     - https://clang.llvm.org/docs/ClangFormat.html
+
+.. list-table:: CSS
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - Stylelint
+     - Yes
+     - `bug 1762027 <https://bugzilla.mozilla.org/show_bug.cgi?id=1762027>`__
+     - :ref:`Stylelint`
+     - https://stylelint.io/
+
+.. list-table:: JavaScript
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - Eslint
+     - Yes
+     - `bug 1229856 <https://bugzilla.mozilla.org/show_bug.cgi?id=1229856>`__
+     - :ref:`ESLint`
+     - https://eslint.org/
+   * - Mozilla ESLint
+     -
+     - `bug 1229856 <https://bugzilla.mozilla.org/show_bug.cgi?id=1229856>`__
+     - :ref:`Mozilla ESLint Plugin`
+     -
+   * - Prettier
+     - Yes
+     - `bug 1558517 <https://bugzilla.mozilla.org/show_bug.cgi?id=1558517>`__
+     - :ref:`JavaScript Coding style`
+     - https://prettier.io/
+
+.. list-table:: Python
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - ruff
+     - Yes
+     - `bug 1811850 <https://bugzilla.mozilla.org/show_bug.cgi?id=1811850>`__
+     - :ref:`ruff`
+     - https://github.com/charliermarsh/ruff
+   * - black
+     - Yes
+     - `bug 1555560 <https://bugzilla.mozilla.org/show_bug.cgi?id=1555560>`__
+     - :ref:`black`
+     - https://black.readthedocs.io/en/stable
+
+.. list-table:: Rust
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - Rustfmt
+     - Yes
+     - `bug 1454764 <https://bugzilla.mozilla.org/show_bug.cgi?id=1454764>`__
+     - :ref:`Rustfmt`
+     - https://github.com/rust-lang/rustfmt
+   * - Clippy
+     -
+     - `bug 1361342 <https://bugzilla.mozilla.org/show_bug.cgi?id=1361342>`__
+     - :ref:`clippy`
+     - https://github.com/rust-lang/rust-clippy
+
+.. list-table:: Java/Kotlin
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - Spotless
+     - Yes
+     - `bug 1571899 <https://bugzilla.mozilla.org/show_bug.cgi?id=1571899>`__
+     - :ref:`Spotless`
+     - https://github.com/diffplug/spotless
+
+.. list-table:: Others
+   :widths: 20 20 20 20 20
+   :header-rows: 1
+
+   * - Tools
+     - Has autofixes
+     - Meta bug
+     - More info
+     - Upstream
+   * - shellcheck
+     -
+     -
+     -
+     - https://www.shellcheck.net/
+   * - rstchecker
+     -
+     -
+     - :ref:`RST Linter`
+     - https://github.com/myint/rstcheck
+   * - Typo detection
+     - Yes
+     -
+     - :ref:`Codespell`
+     - https://github.com/codespell-project/codespell
+   * - Fluent Lint
+     - No
+     -
+     - :ref:`Fluent Lint`
+     -
+   * - YAML linter
+     - No
+     -
+     - :ref:`yamllint`
+     - https://github.com/adrienverge/yamllint
-- 
cgit v1.2.3