summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorJoseph Gordon <gordonj@us.ibm.com>2018-02-09 18:41:48 -0600
committerTrivikram Kamat <16024985+trivikr@users.noreply.github.com>2018-04-14 20:18:03 -0700
commitb003c86bf45d0689d7e77fce0489a6de888b0782 (patch)
treeddbbeb4ca1e98a1d374536ab6b34bc28b34282f0 /BUILDING.md
parent715d7f31b384723b1fc4691cfd54a3e6a1a56bb8 (diff)
downloadandroid-node-v8-b003c86bf45d0689d7e77fce0489a6de888b0782.tar.gz
android-node-v8-b003c86bf45d0689d7e77fce0489a6de888b0782.tar.bz2
android-node-v8-b003c86bf45d0689d7e77fce0489a6de888b0782.zip
doc: improved flow for macOS firewall script
PR-URL: https://github.com/nodejs/node/pull/18689 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/BUILDING.md b/BUILDING.md
index da832c9c24..7b48bb7e05 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -124,18 +124,20 @@ On macOS, you will need to install the `Xcode Command Line Tools` by running
installed, you can find them under the menu `Xcode -> Open Developer Tool ->
More Developer Tools...`. This step will install `clang`, `clang++`, and
`make`.
-* After building, you may want to setup [firewall rules](tools/macosx-firewall.sh)
-to avoid popups asking to accept incoming network connections when running
-tests:
If the path to your build directory contains a space, the build will likely
fail.
+After building, setting up [firewall rules](tools/macosx-firewall.sh) can avoid
+popups asking to accept incoming network connections when running tests.
+
+Running the following script on macOS will add the firewall rules for the
+executable `node` in the `out` directory and the symbolic `node` link in the
+project's root directory.
+
```console
$ sudo ./tools/macosx-firewall.sh
```
-Running this script will add rules for the executable `node` in the `out`
-directory and the symbolic `node` link in the project's root directory.
On FreeBSD and OpenBSD, you may also need:
* libexecinfo