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: Update Command Line Tools download procedure #9215

Closed
wants to merge 1 commit into from

Conversation

jeenalee
Copy link
Contributor

Checklist
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

The way to download Command Line Tools through XCode has been
changed. This patch updates the building documentation to reflect the
changes.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 21, 2016
@mscdex
Copy link
Contributor

mscdex commented Oct 21, 2016

Would it be better to keep both but separate them by version, in case someone has the older version of Xcode? For example:

On OS X, you will also need:

  • Xcode
  • You also need to install the Command Line Tools via Xcode. This can be done from the menu:
    • Xcode 7.x and older: Xcode -> Preferences -> Downloads
    • Xcode 8.x and newer: Xcode -> Open Developer Tool -> More Developer Tools...
  • This step will install gcc and the related toolchain containing make

@mscdex mscdex added the build Issues and PRs related to build files or the CI. label Oct 21, 2016
@targos
Copy link
Member

targos commented Oct 21, 2016

I think we should remove Xcode from the requirements. The minimal required step on OSX is to run xcode-select --install in the Terminal to install the developer tools.

@jeenalee
Copy link
Contributor Author

I had the developer tools installed, but when I tried to build Node.js, it threw an error saying XCode is not installed. I probably had the old version of developer tools though.

I ended up updating OSX to install XCode, and I didn't have to install the command line tools separately.

@targos @mscdex Going forward, what do you suggest? Should I replace XCode with xcode-select --install or specify the instructions based on XCode version?

This is also my first contribution to Node.js. Do you recommend whatever change I make next to be a separate commit, or squashed into one commit? How do you like to do it in Node.js?

@gibfahn
Copy link
Member

gibfahn commented Oct 21, 2016

@jeenalee I have the command-line tools installed, and when I run ./configure I always get two warnings, but I can then go ahead and build node (with macOS Sierra).

As for separate vs squashed, it's personal preference really. I guess if we're exploring different options it might be useful to add another commit so people can compare...

@mscdex
Copy link
Contributor

mscdex commented Oct 21, 2016

How far back does xcode-select --install work for older versions of Xcode? I don't really mind either way, I just thought it might be useful to keep instructions for new and old if the instructions will differ.

@silverwind
Copy link
Contributor

The earliest record I could find point to 10.9 for that method. I'd also be fine if it just says Xcode with Developer Tools. People can easily search on how to install those.

BUILDING.md Outdated
@@ -20,8 +20,9 @@ Prerequisites:

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`
* You also need to install the `Command Line Tools` via Xcode. You
Copy link
Contributor

Choose a reason for hiding this comment

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

why did you wrap "can find" to the next line? Was it over 80 columns? It makes the diff harder to read to find the non-stylistic change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My text editor had 72-character width setting. Sorry, I'll update it.

The instruction on downloading Command Line Tools through XCode has been
changed. This patch updates the building documentation to reflect the
changes.
@jasnell jasnell added the stalled Issues and PRs that are stalled. label Mar 24, 2017
@jasnell
Copy link
Member

jasnell commented Mar 24, 2017

@nodejs/build ... does this make sense to do?

@gibfahn
Copy link
Member

gibfahn commented Mar 24, 2017

I think we should suggest xcode-select --install as that's the minimal way to get everything you need for node.

@fhinkel
Copy link
Member

fhinkel commented May 26, 2017

There hasn't been any activity here. I'm closing this. Feel free to reopen (or ping a collaborator) if I closed this in error.

@fhinkel fhinkel closed this May 26, 2017
gibfahn added a commit to gibfahn/node that referenced this pull request Jun 3, 2017
If you don't have the full Xcode installed, the command-line tools are
all you need.

PR-URL: nodejs#13264
Fixes: nodejs#6449
Refs: nodejs#9215
Reviewed-By: Luigi Pinca <[email protected]>
jasnell pushed a commit that referenced this pull request Jun 5, 2017
If you don't have the full Xcode installed, the command-line tools are
all you need.

PR-URL: #13264
Fixes: #6449
Refs: #9215
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jul 17, 2017
If you don't have the full Xcode installed, the command-line tools are
all you need.

PR-URL: #13264
Fixes: #6449
Refs: #9215
Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. stalled Issues and PRs that are stalled.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants