Skip to content

Commit 0d7e4d5

Browse files
authored
Update getting-started-with-the-codeql-cli.rst
1. The documentation is at least one full macOS release behind, and we're past WWDC so we already know what the next version is. IMO, we should optimize the documentation for the now + future, rather than providing exceptions for them while favoring legacy releases. _Current_ macOS requires the steps that are currently hidden by default; I would recommend inverting the pattern so that _current_ is shown by default, and legacy releases are hidden away. 1. Homebrew is the bread and butter of many developers. Installing Python via Homebrew installs a custom version of `xattr` that is different from the system's `xattr`, which doesn't support the `-c` flag. By specifically executing the system-provided version of `xattr` by path, you are more-or-less guaranteed to get the system-provided `xattr` with the expected `-c` flag.
1 parent ca4c519 commit 0d7e4d5

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ structures. To get started quickly, we recommend adopting a relatively simple
1818
setup, as outlined in the steps below.
1919

2020
If you use Linux, Windows, or macOS version 10.14 ("Mojave") or earlier, simply
21-
follow the steps below. For macOS version 10.15 ("Catalina"), steps 1 and 4 are
22-
slightly different---for further details, see the sections labeled **Information
23-
for macOS "Catalina" users**.
21+
follow the steps below. For macOS version 10.15 ("Catalina") or newer, steps 1
22+
and 4 are slightly different---for further details, see the sections labeled
23+
**Information for macOS "Catalina" (or newer) users**.
2424

2525
1. Download the CodeQL CLI zip package
2626
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,13 +61,14 @@ Alternatively, you can download ``codeql.zip``, which contains the CLI for all s
6161

6262
.. container:: name
6363

64-
**Information for macOS "Catalina" users**
64+
**Information for macOS "Catalina" (or newer) users**
6565

66-
.. pull-quote:: macOS "Catalina"
66+
.. pull-quote:: macOS "Catalina" (or newer)
6767

68-
If you use macOS version 10.15 ("Catalina"), you need to ensure that your web
69-
browser does not automatically extract zip files. If you use Safari,
70-
complete the following steps before downloading the CodeQL CLI zip archive:
68+
If you use macOS version 10.15 ("Catalina"), version 11 ("Big Sur"), or the upcoming
69+
version 12 ("Monterey"), you need to ensure that your web browser does not automatically
70+
extract zip files. If you use Safari, complete the following steps before downloading
71+
the CodeQL CLI zip archive:
7172

7273
i. Open Safari.
7374
ii. From the Safari menu, select **Preferences...**.
@@ -159,16 +160,17 @@ For example, if the path to your copy of the CodeQL repository is
159160

160161
.. container:: name
161162

162-
**Information for macOS "Catalina" users**
163+
**Information for macOS "Catalina" (or newer) users**
163164

164165
.. pull-quote:: macOS "Catalina"
165166

166-
macOS "Catalina" users should run the following commands in the Terminal,
167-
where ``${install_loc}`` is the path to the directory you created in step 2:
167+
macOS "Catalina", "Big Sur", or "Monterey" users should run the following
168+
commands in the Terminal, where ``${install_loc}`` is the path to the
169+
directory you created in step 2:
168170

169171
i. ``mv ~/Downloads/codeql*.zip ${install_loc}``
170172
ii. ``cd ${install_loc}``
171-
iii. ``xattr -c codeql*.zip``
173+
iii. ``/usr/bin/xattr -c codeql*.zip``
172174
iv. ``unzip codeql*.zip``
173175

174176
5. Launch ``codeql``

0 commit comments

Comments
 (0)