doc: minor improvements in BUILDING.md#11963
doc: minor improvements in BUILDING.md#11963thefourtheye wants to merge 1 commit intonodejs:masterfrom
Conversation
BUILDING.md
Outdated
There was a problem hiding this comment.
- Verify with
node -p "process.versions.openssl"
Maybe specify how you know the build was done in FIPS mode? Maybe:
- Verify that the openssl version contains "fips":
node -p "process.versions.openssl"(for example1.0.2a-fips)
BUILDING.md
Outdated
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I changed it to May not compile reliably or test suite may not pass.. Is that okay?
BUILDING.md
Outdated
There was a problem hiding this comment.
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.]
There was a problem hiding this comment.
Mmmm, I am leaving this as it is for now.
4df867a to
0747c53
Compare
BUILDING.md
Outdated
There was a problem hiding this comment.
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.
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
|
Landed in ba0e3ac |
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. 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. 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. 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]>
consolehighlighting, astestalone is highlighted/usr/local/ssl/fips-2.0process.versions.opensslas the versiondisplayed is not mentioned in the document
Checklist
Affected core subsystem(s)
doc
cc @mhdawson