From fedde13549f06c9fbd124f23c39a84112d761633 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Wed, 13 May 2020 09:32:57 +0000 Subject: [PATCH] Bug 1636494 - doc: update the doc about some of the lint job moved to tier-2 r=linter-reviewers,ahal Depends on D74435 Differential Revision: https://phabricator.services.mozilla.com/D74436 --- docs/code-quality/lint/create.rst | 4 ++++ docs/code-quality/lint/linters/codespell.rst | 1 + docs/code-quality/lint/linters/file-perm.rst | 2 ++ docs/code-quality/lint/linters/file-whitespace.rst | 2 ++ 4 files changed, 9 insertions(+) diff --git a/docs/code-quality/lint/create.rst b/docs/code-quality/lint/create.rst index 6a72b1b60567..98d256942e79 100644 --- a/docs/code-quality/lint/create.rst +++ b/docs/code-quality/lint/create.rst @@ -321,4 +321,8 @@ For example, for flake8, the configuration is the following: If the linter requires an external program, you will have to install it in the `setup script `_ and maybe install the necessary files in the `Docker configuration `_. +.. note:: + If the defect found by the linter is minor, make sure that it is run as `tier 2 `_. + This prevents the tree from closing because of a tiny issue. + For example, the typo detection is run as tier-2. diff --git a/docs/code-quality/lint/linters/codespell.rst b/docs/code-quality/lint/linters/codespell.rst index 568c477559f1..e5804d30bb05 100644 --- a/docs/code-quality/lint/linters/codespell.rst +++ b/docs/code-quality/lint/linters/codespell.rst @@ -21,6 +21,7 @@ Configuration To enable codespell on new directory, add the path to the include section in the `codespell.yml `_ file. +This job is configured as `tier 2 `_. Autofix ------- diff --git a/docs/code-quality/lint/linters/file-perm.rst b/docs/code-quality/lint/linters/file-perm.rst index a1b9044665ee..edc275bfd539 100644 --- a/docs/code-quality/lint/linters/file-perm.rst +++ b/docs/code-quality/lint/linters/file-perm.rst @@ -25,6 +25,8 @@ Configuration This linter is enabled on the whole code base. +This job is configured as `tier 2 `_. + Autofix ------- diff --git a/docs/code-quality/lint/linters/file-whitespace.rst b/docs/code-quality/lint/linters/file-whitespace.rst index a1e3b6555187..996e44340b73 100644 --- a/docs/code-quality/lint/linters/file-whitespace.rst +++ b/docs/code-quality/lint/linters/file-whitespace.rst @@ -20,6 +20,8 @@ Configuration This linter is enabled on most of the code base. +This job is configured as `tier 2 `_. + Autofix -------