Skip to content

Commit 9421d02

Browse files
committed
adjusted commands for cqas
1 parent 5c35b39 commit 9421d02

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

docs/cqa/index/index.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,33 @@
66

77
## Helpful Commands
88

9-
Run Vale on an assembly and all modules included in it:
9+
Run Vale on a specific assembly and all modules included in it:
1010

1111
```
12-
vale --minAlertLevel=warning example-assembly.adoc $(grep -oP 'include::\K[^[]+' example-assembly.adoc | grep -v '_attributes/common-attributes.adoc')
12+
vale --minAlertLevel=warning \
13+
example-assembly.adoc \
14+
$(grep -oP 'include::\K[^[]+' example-assembly.adoc \
15+
| grep -v '_attributes/common-attributes.adoc')
16+
```
17+
18+
Run Vale on a directory of assemblies and all modules included in those assemblies:
19+
20+
```
21+
vale --minAlertLevel=warning \
22+
$(find virt/live_migration -name "*.adoc") \
23+
$(grep -rhoP 'include::\K[^[]+' virt/live_migration | grep -v '_attributes/common-attributes.adoc' | sort -u)
1324
```
1425

1526
List `_mod-docs-content-type` for all modules included in an assembly and print `MISSING` if the attribute is not present:
1627

1728
```
18-
for f in $(grep -oP 'include::\K[^[]+' example-assembly.adoc | grep '^modules/' | sort -u); do echo "==> $f <=="; grep '^:_mod-docs-content-type:' "$f" || echo 'MISSING'; echo; done
29+
for f in $(grep -oP 'include::\K[^[]+' example-assembly.adoc \
30+
| grep '^modules/' \
31+
| sort -u); do
32+
echo "==> $f <=="
33+
grep '^:_mod-docs-content-type:' "$f" || echo 'MISSING'
34+
echo
35+
done
1936
```
2037

2138
## Resources

0 commit comments

Comments
 (0)