Skip to content

Commit ba0e3ac

Browse files
committed
doc: minor improvements in BUILDING.md
1. necessarily reliably => necessarily reliable 2. projects root directory => project's root directory 3. remove `console` highlighting, as `test` alone is highlighted 4. fix broken link for Android NDK 5. highlight the directory location `/usr/local/ssl/fips-2.0` 6. update expected output to an example for `process.versions.openssl` as the version displayed is not mentioned in the document PR-URL: #11963 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent d75fdd9 commit ba0e3ac

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

BUILDING.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,10 @@ Support is divided into three tiers:
2626
the broader community.
2727
* **Tier 2**: Full test coverage but more limited maintenance,
2828
often provided by the vendor of the platform.
29-
* **Experimental**: Known to compile but not necessarily reliably or with
30-
a full passing test suite. These are often working to be promoted to Tier
31-
2 but are not quite ready. There is at least one individual actively
32-
providing maintenance and the team is striving to broaden quality and
33-
reliability of support.
29+
* **Experimental**: May not compile reliably or test suite may not pass.
30+
These are often working to be promoted to Tier 2 but are not quite ready.
31+
There is at least one individual actively providing maintenance and the team
32+
is striving to broaden quality and reliability of support.
3433

3534
### Supported platforms
3635

@@ -96,7 +95,7 @@ to avoid popups asking to accept incoming network connections when running tests
9695
$ sudo ./tools/macosx-firewall.sh
9796
```
9897
Running this script will add rules for the executable `node` in the out
99-
directory and the symbolic `node` link in the projects root directory.
98+
directory and the symbolic `node` link in the project's root directory.
10099

101100
On FreeBSD and OpenBSD, you may also need:
102101
* libexecinfo
@@ -121,7 +120,7 @@ and not a newer version.
121120

122121
To run the tests:
123122

124-
```console
123+
```
125124
$ make test
126125
```
127126

@@ -206,9 +205,9 @@ in the current continuous integration environment. The participation of people
206205
dedicated and determined to improve Android building, testing, and support is
207206
encouraged.
208207

209-
Be sure you have downloaded and extracted [Android NDK]
210-
(https://developer.android.com/tools/sdk/ndk/index.html)
211-
before in a folder. Then run:
208+
Be sure you have downloaded and extracted
209+
[Android NDK](https://developer.android.com/tools/sdk/ndk/index.html) before in
210+
a folder. Then run:
212211

213212
```console
214213
$ ./android-configure /path/to/your/android-ndk
@@ -350,6 +349,6 @@ and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf).
350349
6. Get into Node.js checkout folder
351350
7. `./configure --openssl-fips=/path/to/openssl-fips/installdir`
352351
For example on ubuntu 12 the installation directory was
353-
/usr/local/ssl/fips-2.0
352+
`/usr/local/ssl/fips-2.0`
354353
8. Build Node.js with `make -j`
355-
9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`)
354+
9. Verify with `node -p "process.versions.openssl"` (for example `1.0.2a-fips`)

0 commit comments

Comments
 (0)