summaryrefslogtreecommitdiffstats
path: root/docs/usage.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-26 06:24:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-26 06:24:58 +0000
commitba233a0cbad76b4783a03893e7bf4716fbc0f0ec (patch)
treead369728c1edbe3631c8150585659078ae5d7d0b /docs/usage.md
parentReleasing progress-linux version 6.17.2-3~progress7.99u1. (diff)
downloadansible-lint-ba233a0cbad76b4783a03893e7bf4716fbc0f0ec.tar.xz
ansible-lint-ba233a0cbad76b4783a03893e7bf4716fbc0f0ec.zip
Merging upstream version 24.6.1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/usage.md')
-rw-r--r--docs/usage.md20
1 files changed, 7 insertions, 13 deletions
diff --git a/docs/usage.md b/docs/usage.md
index dbe115d..da059a1 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -43,11 +43,11 @@ repositories.
## Gradual adoption
For an easier gradual adoption, adopters should consider [ignore
-file][configuring.md#ignoring-rules-for-entire-files] feature. This allows the
-quick introduction of a linter pipeline for preventing addition of new
-violations, while known violations are ignored. Some people can work on
-addressing these historical violations while others may continue to work on
-other maintenance tasks.
+file][ignoring-rules-for-entire-files] feature. This allows the quick
+introduction of a linter pipeline for preventing the addition of new violations,
+while known violations are ignored. Some people can work on addressing these
+historical violations while others may continue to work on other maintenance
+tasks.
The deprecated `--progressive` mode was removed in v6.16.0 as it added code
complexity and performance overhead. It also presented several corner cases
@@ -124,7 +124,7 @@ ansible-lint --offline -q -f codeclimate examples/playbooks/norole.yml
```
Historically `-f json` was used to generate Code Climate JSON reports but in
-never versions we switched its meaning point SARIF JSON format instead.
+newer versions we switched its meaning point SARIF JSON format instead.
!!! warning
@@ -222,18 +222,12 @@ argument or add it to `skip_list` in your configuration.
The least preferred method of skipping rules is to skip all task-based rules for
a task, which does not skip line-based rules. You can use the
-`skip_ansible_lint` tag with all tasks or the `warn` parameter with the
-_command_ or _shell_ modules, for example:
+`skip_ansible_lint` tag with all tasks, for example:
```yaml
- name: This would typically fire no-free-form
command: warn=no chmod 644 X
-- name: This would typically fire command-instead-of-module
- command: git pull --rebase
- args:
- warn: false
-
- name: This would typically fire git-latest
git: src=/path/to/git/repo dest=checkout
tags: