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: update build instructions for OS X #6309

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
9 participants
@Trott
Member

Trott commented Apr 20, 2016

Checklist
  • tests and code linting passes
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc build

Description of change

Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to Macintosh in BUILDING.md to
refer to OS X. This is consistent with the way other references are to
operating system families (Unix, Windows) and not brand names or
hardware architectures.

@Trott Trott added doc build labels Apr 20, 2016

@addaleax

View changes

Show outdated Hide outdated BUILDING.md
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Apr 20, 2016

Member

LGTM

Member

jasnell commented Apr 20, 2016

LGTM

@cjihrig

This comment has been minimized.

Show comment
Hide comment
@cjihrig

cjihrig Apr 20, 2016

Contributor

LGTM

Contributor

cjihrig commented Apr 20, 2016

LGTM

@wonderdogone

This comment has been minimized.

Show comment
Hide comment
@wonderdogone

wonderdogone Apr 20, 2016

I think what might be slightly confusing is that Xcode install takes care of most all the build chain needed (except python) . Unless things have changed I remember that getting node to build on OSX was as simple as
1- making sure your xcode is up to date.
2- updating or installing node-gyp (npm install node-gyp)

Might not have to include the section that suggest manually grabbing gcc and clang? What could potentially happen is a person could install xcode, then override clang version by accident manually and then the xcode will start complaining?

wonderdogone commented Apr 20, 2016

I think what might be slightly confusing is that Xcode install takes care of most all the build chain needed (except python) . Unless things have changed I remember that getting node to build on OSX was as simple as
1- making sure your xcode is up to date.
2- updating or installing node-gyp (npm install node-gyp)

Might not have to include the section that suggest manually grabbing gcc and clang? What could potentially happen is a person could install xcode, then override clang version by accident manually and then the xcode will start complaining?

@mscdex mscdex added the macos label Apr 20, 2016

@bnoordhuis

View changes

Show outdated Hide outdated BUILDING.md
@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Apr 27, 2016

Member

@wonderdogone You raise good points. I'm not sure what the best way to deal with it is. It might make sense to separate out OS X prerequisites entirely from *nix prerequisites.

I think the current status of this PR is an improvement over the current document and am inclined to land this, and then work on (or let someone else work on) further improvements along those lines. Would you strongly disagree with any of that approach?

Member

Trott commented Apr 27, 2016

@wonderdogone You raise good points. I'm not sure what the best way to deal with it is. It might make sense to separate out OS X prerequisites entirely from *nix prerequisites.

I think the current status of this PR is an improvement over the current document and am inclined to land this, and then work on (or let someone else work on) further improvements along those lines. Would you strongly disagree with any of that approach?

@jbergstroem

View changes

Show outdated Hide outdated BUILDING.md
@jbergstroem

View changes

Show outdated Hide outdated BUILDING.md
doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.
@jbergstroem

This comment has been minimized.

Show comment
Hide comment
@jbergstroem

jbergstroem Apr 27, 2016

Member

Looks Good To Me.

Member

jbergstroem commented Apr 27, 2016

Looks Good To Me.

Trott added a commit to Trott/io.js that referenced this pull request Apr 28, 2016

doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: nodejs#6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Apr 28, 2016

Member

Landed in 153b796. Will open a new issue for some of the other things brought up in the conversation.

Member

Trott commented Apr 28, 2016

Landed in 153b796. Will open a new issue for some of the other things brought up in the conversation.

@Trott Trott closed this Apr 28, 2016

@wonderdogone

This comment has been minimized.

Show comment
Hide comment
@wonderdogone

wonderdogone commented May 3, 2016

agreed..

Fishrock123 added a commit that referenced this pull request May 4, 2016

doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: #6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>

MylesBorins added a commit that referenced this pull request Jun 1, 2016

doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: #6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>

@MylesBorins MylesBorins referenced this pull request Jun 24, 2016

Merged

v4.4.7 proposal #7395

MylesBorins added a commit that referenced this pull request Jun 24, 2016

doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: #6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>

MylesBorins added a commit that referenced this pull request Jun 24, 2016

doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: #6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>

@MylesBorins MylesBorins removed their assignment Dec 27, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment