doc: add note to ninjia build for macOS using -jn flag #53187
Conversation
|
Review requested:
|
|
My apology, I had no intention to tag tsc. |
| @@ -38,6 +38,10 @@ make -j4 # With this flag, Ninja will limit itself to 4 parallel jobs, | |||
| # regardless of the number of cores on the current machine. | |||
| ``` | |||
|
|
|||
| Note: if you are on macOS and use GNU Make version `3.x`, the `-jn` flag | |||
| will not work. You can either upgrade to `v4.x` (e.g. using a package manager | |||
| such as [Homebrew](https://formulae.brew.sh/formula/make#default)) or use `make JOBS=n`. | |||
There was a problem hiding this comment.
If JOBS=n works for all make versions, why don’t we just change the docs to recommend it as the only solution? It’s much more straightforward than telling people to upgrade their make.
There was a problem hiding this comment.
IMO I guess it would be better to leave people with options that they can choose? e.g. some people may have already used to the make -jn and wanna keep using it across Linux and Mac.
There was a problem hiding this comment.
What's the advantage of listing both options if they do the same thing?
There was a problem hiding this comment.
make -jn is a widely used convention and shorter to type than setting JOBS. Also, if one accidentally mistyped -jn, there will almost certainly be an error, whereas mistyping the name of a variable usually doesn't even give a warning.
I don't know why Apple ships an ancient version of make by default, but it seems that upgrading it is easy enough.
There was a problem hiding this comment.
I upgraded it via brew and I still got the error. Switching to the variable worked for me. Presumably the upgrade didn't put the new version in my path or something but I didn't dig into it.
There was a problem hiding this comment.
So essentially the instructions are:
Use
JOBS=N; or if you’re on macOS and you want to type-jNinstead, use Homebrew to upgrademakeand add$HOMEBREW_PREFIX/opt/make/libexec/gnubinto your$PATH
The second option is so complex that I don’t really see the point in mentioning it?
There was a problem hiding this comment.
Honestly it's up to Apple to provide their users with a version of make that isn't old enough to vote in most countries.
As long as they don't, we can — and probably should — give users both options. Clearly, there is an expectation among contributors that -jn should work, and it can.
If you think the details of upgrading to a version of make from the last decade are too complex/verbose, we can probably omit those and just say "please upgrade to version 4 of GNU make" as option two.
In any case, if probably doesn't hurt to make does not work a hyperlink to the issue that Yagiz created so that readers can find plenty of context there.
There was a problem hiding this comment.
I also don’t understand how this broke. I’ve used -j8 for years on Mac and it was only recently that it started erroring for me, and fortunately I happened to find this PR. So I’m all for updating the instructions, but did we change something recently that requires a newer make? If so, is this the only thing that’s broken in the old make or should we do some kind of check that users are running make 4+?
If using the old make is okay, I would update all the places we currently mention -jN to instead be JOBS=N and then add a note like “If you are using a current version of make, which is likely for most Linux OSes but currently not for macOS, you can replace JOBS=N with -jN.” As in, we should default to the instruction that should work for everyone.
There was a problem hiding this comment.
FWIW I installed an up-to-date version using Nix, I had to restart my shell and it worked fine. I'm -1 on Goeffrey's proposal, I agree with Tobias it's up to the user to use an up-to-date version of make. If it's upgrading is too complicated, not passing -j is also an option – and you'd get the same behavior as before – and also building with ninja is not the default.
There was a problem hiding this comment.
I also don’t understand how this broke. I’ve used -j8 for years on Mac and it was only recently that it started erroring for me
The sad story is that -jn may never have truly worked. see #53176 (comment),
#53176 (comment),
#53176 (comment).
(the tldr is that I have tested on the previous "working" version and found the -jn was not being propagated)
aduh95
added
author ready
nodejs-github-bot
removed
the
commit-queue
|
Landed in 47c5571 |
PR-URL: nodejs#53187 Fixes: nodejs#53176 Refs: nodejs#53176 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
PR-URL: nodejs#53187 Fixes: nodejs#53176 Refs: nodejs#53176 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Adding a note to macOS build as
make -jnwill no longer work with GNU makev3.8.xFixes: #53176 (comment), #53176 (comment)
Refs: #53176
cc @tniessen @targos @anonrig @lpinca