Skip to content

Commit ef3b750

Browse files
committed
clarify usage
1 parent 33ecdcc commit ef3b750

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

misc/scripts/resolve-code-scanning-query-packs.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@
99
and prints CSV data to stdout that describes which packs contain which queries.
1010
1111
Errors are printed to stderr. This script requires that 'git' and 'codeql' commands
12-
are on the PATH, and should be run either from within a clone of github/codeql,
13-
or in the parent directory thereof. It expects a directory 'codeql-go' as a sibling
14-
of the github/codeql clone.
12+
are on the PATH. It'll try to automatically set the CodeQL search path correctly,
13+
as long as you run the script from one of the following locations:
14+
- anywhere from within a clone of the CodeQL Git repo
15+
- from the parent directory of a clone of the CodeQL Git repo (assuming 'codeql'
16+
and 'codeql-go' directories both exist)
1517
"""
1618

1719
# Define which languages and query packs to consider

0 commit comments

Comments
 (0)