Skip to content

Commit

Permalink
Fix incorrect documentation of playbook and roles linting (#4266)
Browse files Browse the repository at this point in the history
Co-authored-by: Aine Riordan <[email protected]>
  • Loading branch information
MatthiasKunnen and ariordan-redhat authored Jul 23, 2024
1 parent 251aed4 commit 9d5fd79
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ because it helps those tools better distinguish between random YAML files and
files managed by Ansible. When you call `ansible-lint` without arguments, it
uses internal heuristics to determine file types.

You can specify the list of **roles** or **playbooks** that you want to lint
with the `-p` argument. For example, to lint `examples/playbooks/play.yml` and
Pass the **roles** and **playbooks** that you want to lint as arguments to the `ansible-lint` command.
For example, to lint `examples/playbooks/play.yml` and
`examples/roles/bobbins`, use the following command:

```console exec="1" source="console" returncode="2"
$ ansible-lint --offline -p examples/playbooks/play.yml examples/roles/bobbins
$ ansible-lint examples/playbooks/play.yml examples/roles/bobbins
```

[collection structure layout]:
Expand Down

0 comments on commit 9d5fd79

Please sign in to comment.