Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: minor improvements in BUILDING.md #11963

Closed
wants to merge 1 commit into from

Conversation

@thefourtheye
Copy link
Contributor

commented Mar 21, 2017

  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. remove expected output for process.versions.openssl as the version
    displayed is not mentioned in the document
Checklist
Affected core subsystem(s)

doc


cc @mhdawson

@mscdex mscdex added the build label Mar 21, 2017

@mhdawson
Copy link
Member

left a comment

LGTM

BUILDING.md Outdated
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"`

This comment has been minimized.

Copy link
@gibfahn

gibfahn Mar 22, 2017

Member
  1. Verify with node -p "process.versions.openssl"

Maybe specify how you know the build was done in FIPS mode? Maybe:

  1. Verify that the openssl version contains "fips": node -p "process.versions.openssl" (for example1.0.2a-fips)

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 1, 2017

Author Contributor

Ack

BUILDING.md Outdated
@@ -26,7 +26,7 @@ Support is divided into three tiers:
the broader community.
* **Tier 2**: Full test coverage but more limited maintenance,
often provided by the vendor of the platform.
* **Experimental**: Known to compile but not necessarily reliably or with
* **Experimental**: Known to compile but not necessarily reliable or with

This comment has been minimized.

Copy link
@Trott

Trott Mar 22, 2017

Member

I think reliably is the correct word here. A fuller sentence would be: This is known to compile but it does not necessarily compile reliably or with a full passing test suite.

That said, all the qualifiers (known to, not necessarily, reliably...) are redundant. Maybe replace the whole sentence with something like this?:

May not compile reliably. Test suite may not pass.

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 1, 2017

Author Contributor

I changed it to May not compile reliably or test suite may not pass.. Is that okay?

@@ -121,7 +121,7 @@ and not a newer version.

To run the tests:

```console

This comment has been minimized.

Copy link
@Trott

Trott Mar 22, 2017

Member

I'm pretty sure I'm the one that added console. The idea was to distinguish between something that was a command (such as make test) and something which was console display (as it is here because it includes the $ prompt).

All that said, I don't actually care if it goes away. :-D

[UPDATE: Nope, I'm wrong about it being me; git blame says it was @ChALkeR.]

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 1, 2017

Author Contributor

Mmmm, I am leaving this as it is for now.

@thefourtheye thefourtheye force-pushed the thefourtheye:fix-typo branch 2 times, most recently Apr 1, 2017

BUILDING.md Outdated
@@ -206,8 +205,7 @@ in the current continuous integration environment. The participation of people
dedicated and determined to improve Android building, testing, and support is
encouraged.

Be sure you have downloaded and extracted [Android NDK]
(https://developer.android.com/tools/sdk/ndk/index.html)
Be sure you have downloaded and extracted [Android NDK](https://developer.android.com/tools/sdk/ndk/index.html)

This comment has been minimized.

Copy link
@gibfahn

gibfahn Apr 1, 2017

Member

Could you do it like:

Download and extract the
[Android NDK](https://developer.android.com/tools/sdk/ndk/index.html),
then run:

? That way you keep it <80 chars and the link should still work.

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 2, 2017

Author Contributor

Ack

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. remove expected output for `process.versions.openssl` as the version
   displayed is not mentioned in the document

@thefourtheye thefourtheye force-pushed the thefourtheye:fix-typo branch to 0089f85 Apr 2, 2017

@gibfahn
gibfahn approved these changes Apr 2, 2017
@thefourtheye

This comment has been minimized.

Copy link
Contributor Author

commented Apr 4, 2017

Landed in ba0e3ac

@thefourtheye thefourtheye deleted the thefourtheye:fix-typo branch Apr 4, 2017

thefourtheye added a commit that referenced this pull request Apr 4, 2017
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 <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>
@jasnell jasnell referenced this pull request Apr 4, 2017
@gibfahn gibfahn referenced this pull request Jun 15, 2017
2 of 3 tasks complete
gibfahn added a commit that referenced this pull request Jun 17, 2017
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 <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>
gibfahn added a commit that referenced this pull request Jun 20, 2017
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 <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>
MylesBorins added a commit that referenced this pull request Jul 11, 2017
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 <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>
@MylesBorins MylesBorins referenced this pull request Jul 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
9 participants
You can’t perform that action at this time.