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.

Sign up for GitHub

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

Jump to bottom

doc: update build instructions for OS X #6309

Closed
wants to merge 1 commit into from
Closed

doc: update build instructions for OS X #6309

wants to merge 1 commit into from

Conversation

Trott
Copy link
Member

@Trott 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 Issues and PRs related to the documentations. build Issues and PRs related to build files or the CI. labels Apr 20, 2016
addaleax
addaleax reviewed Apr 20, 2016
View reviewed changes
BUILDING.md
* You also need to install the `Command Line Tools` via Xcode. You can find this under the menu `Xcode -> Preferences -> Downloads`
* This step will install `gcc` and the related toolchain containing `make`

On FreeBSD and OpenBSD, you will also need:
* libexecinfo (FreeBSD and OpenBSD only)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The (FreeBSD and OpenBSD only) note seems a bit redundant now :-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax wrote:

The (FreeBSD and OpenBSD only) note seems a bit redundant now :-)

Fixed. Thanks!

@jasnell
Copy link
Member

jasnell commented Apr 20, 2016

LGTM

1 similar comment
@cjihrig
Copy link
Contributor

cjihrig commented Apr 20, 2016

LGTM

@wonderdogone
Copy link

wonderdogone commented Apr 20, 2016 •
edited
Loading

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 Issues and PRs related to the macOS platform / OSX. label Apr 20, 2016
bnoordhuis
bnoordhuis reviewed Apr 20, 2016
View reviewed changes
BUILDING.md

On OS X, you will also need:
* [Xcode](https://developer.apple.com/xcode/download/)
* You also need to install the `Command Line Tools` via Xcode. You can find this under the menu `Xcode -> Preferences -> Downloads`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Long line.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bnoordhuis wrote:

Long line.

Fixed. Thanks!

@Trott Trott force-pushed the xcode branch 3 times, most recently from 3b54f1a to 481d6ad Compare April 27, 2016 00:02
@Trott
Copy link
Member Author

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
jbergstroem reviewed Apr 27, 2016
View reviewed changes
BUILDING.md

On OS X, you will also need:
* [Xcode](https://developer.apple.com/xcode/download/)
* You also need to install the `Command Line Tools` via Xcode. You can find
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think xcode is optional; you can get the cli tools separately. Re-iterating my statement from this mornings call wrt me being a user not a osx expert, but something like xcode-select --install could work?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, to test this, we need a pristine OS X for someone to try it out on. Anyone? Anyone?

Does the OS X in CI build from scratch, more or less? If so, does it install XCode?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rvagg ^

(likely installed xcode)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happily, @thealphanerd volunteered to install a vanilla OS X VM and test whether build works without installing full XCode or not. Go, @thealphanerd!

@Trott
doc: update build instructions for OS X
156288e 
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
Copy link
Member

Looks Good To Me.

Trott added a commit to Trott/io.js that referenced this pull request Apr 28, 2016
@Trott
doc: update build instructions for OS X
153b796 
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Johan Bergström <[email protected]>
@Trott
Copy link
Member Author

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
Copy link

agreed..

Fishrock123 pushed a commit that referenced this pull request May 4, 2016
@Trott @Fishrock123
doc: update build instructions for OS X
f6d7279 
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Johan Bergström <[email protected]>
This was referenced May 4, 2016
Closed
Merged
MylesBorins pushed a commit that referenced this pull request Jun 1, 2016
@Trott
doc: update build instructions for OS X
cb069f6 
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Johan Bergström <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jun 24, 2016
Merged
MylesBorins pushed a commit that referenced this pull request Jun 24, 2016
@Trott
doc: update build instructions for OS X
feda15b 
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Johan Bergström <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jun 24, 2016
@Trott
doc: update build instructions for OS X
56d4594 
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Johan Bergström <[email protected]>
@MylesBorins MylesBorins removed their assignment Dec 27, 2016
@Trott Trott deleted the xcode branch January 13, 2022 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. macos Issues and PRs related to the macOS platform / OSX.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@Trott @jasnell @cjihrig @wonderdogone @jbergstroem @bnoordhuis @addaleax @mscdex @MylesBorins