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: edit BUILDING.md #23435

Closed
wants to merge 1 commit into from

Conversation

@Trott
Copy link
Member

commented Oct 12, 2018

I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.
@targos
targos approved these changes Oct 12, 2018
@refack
refack approved these changes Oct 12, 2018
Windows binary (`node.exe`) in WSL is not recommended, and will not work
without adjustment (such as stdio redirection).
Windows binary (`node.exe`) in WSL is not recommended. It will not work
without workarounds such as stdio redirection.

This comment has been minimized.

Copy link
@addaleax

addaleax Oct 12, 2018

Member

I’d just skip the “such as stdio redirection” bit entirely unless we can actually explain how to redirect stdio.

This comment has been minimized.

Copy link
@refack

This comment has been minimized.

Copy link
@addaleax

addaleax Oct 13, 2018

Member

@refack It’s absolutely not obvious how WSL and running in terminal emulators are related. When adding back this piece, please suggest wording that actually explains this or links back to the footnote you linked here.

@Trott Trott added the author ready label Oct 12, 2018

BUILDING.md Outdated
Windows binary (`node.exe`) in WSL is not recommended, and will not work
without adjustment (such as stdio redirection).
Windows binary (`node.exe`) in WSL is not recommended. It will not work
without workarounds.

This comment has been minimized.

Copy link
@refack

refack Oct 13, 2018

Member

The (such as stdio redirection) bit is the most significant workaround, as in if it's done the Windows Binary works 99% of the time. IMHO it should stay.

This comment has been minimized.

Copy link
@refack

refack Oct 13, 2018

Member

See original discussion in #17008

This comment has been minimized.

Copy link
@Trott

Trott Oct 14, 2018

Author Member

Since removing it was an optional nit in the first place, I'll restore it.

@sagirk
sagirk approved these changes Oct 13, 2018
@gdams
gdams approved these changes Oct 14, 2018

@Trott Trott force-pushed the Trott:building-revisions branch from f1fed7c to 88874e3 Oct 14, 2018

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 14, 2018

@refack
refack approved these changes Oct 14, 2018
@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 14, 2018

Landed in eeb2c8f

@Trott Trott closed this Oct 14, 2018

Trott added a commit to Trott/io.js that referenced this pull request Oct 14, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: nodejs#23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
addaleax added a commit that referenced this pull request Oct 14, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: #23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
burgerboydaddy added a commit to burgerboydaddy/node that referenced this pull request Oct 17, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: nodejs#23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
jasnell added a commit that referenced this pull request Oct 17, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: #23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
MylesBorins added a commit that referenced this pull request Oct 30, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: #23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
@codebytere codebytere referenced this pull request Nov 27, 2018
rvagg added a commit that referenced this pull request Nov 28, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: #23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
MylesBorins added a commit that referenced this pull request Nov 29, 2018
doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: #23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
@codebytere codebytere referenced this pull request Nov 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.