Browse Source

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: https://github.com/nodejs/node/pull/11963

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
v6
Sakthipriyan Vairamani (thefourtheye) 8 years ago
parent
commit
ba0e3ac53d
No known key found for this signature in database GPG Key ID: C71F2437E9591758
  1. 23
      BUILDING.md

23
BUILDING.md

@ -26,11 +26,10 @@ Support is divided into three tiers:
the broader community. the broader community.
* **Tier 2**: Full test coverage but more limited maintenance, * **Tier 2**: Full test coverage but more limited maintenance,
often provided by the vendor of the platform. often provided by the vendor of the platform.
* **Experimental**: Known to compile but not necessarily reliably or with * **Experimental**: May not compile reliably or test suite may not pass.
a full passing test suite. These are often working to be promoted to Tier These are often working to be promoted to Tier 2 but are not quite ready.
2 but are not quite ready. There is at least one individual actively There is at least one individual actively providing maintenance and the team
providing maintenance and the team is striving to broaden quality and is striving to broaden quality and reliability of support.
reliability of support.
### Supported platforms ### Supported platforms
@ -96,7 +95,7 @@ to avoid popups asking to accept incoming network connections when running tests
$ sudo ./tools/macosx-firewall.sh $ sudo ./tools/macosx-firewall.sh
``` ```
Running this script will add rules for the executable `node` in the out Running this script will add rules for the executable `node` in the out
directory and the symbolic `node` link in the projects root directory. directory and the symbolic `node` link in the project's root directory.
On FreeBSD and OpenBSD, you may also need: On FreeBSD and OpenBSD, you may also need:
* libexecinfo * libexecinfo
@ -121,7 +120,7 @@ and not a newer version.
To run the tests: To run the tests:
```console ```
$ make test $ make test
``` ```
@ -206,9 +205,9 @@ in the current continuous integration environment. The participation of people
dedicated and determined to improve Android building, testing, and support is dedicated and determined to improve Android building, testing, and support is
encouraged. encouraged.
Be sure you have downloaded and extracted [Android NDK] Be sure you have downloaded and extracted
(https://developer.android.com/tools/sdk/ndk/index.html) [Android NDK](https://developer.android.com/tools/sdk/ndk/index.html) before in
before in a folder. Then run: a folder. Then run:
```console ```console
$ ./android-configure /path/to/your/android-ndk $ ./android-configure /path/to/your/android-ndk
@ -350,6 +349,6 @@ and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf).
6. Get into Node.js checkout folder 6. Get into Node.js checkout folder
7. `./configure --openssl-fips=/path/to/openssl-fips/installdir` 7. `./configure --openssl-fips=/path/to/openssl-fips/installdir`
For example on ubuntu 12 the installation directory was For example on ubuntu 12 the installation directory was
/usr/local/ssl/fips-2.0 `/usr/local/ssl/fips-2.0`
8. Build Node.js with `make -j` 8. Build Node.js with `make -j`
9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`) 9. Verify with `node -p "process.versions.openssl"` (for example `1.0.2a-fips`)

Loading…
Cancel
Save