doc: blorb about `npm_config_devdir` #1185

refack · 2017-04-27T22:09:03Z

gibfahn · 2017-04-27T22:52:24Z

I'm pretty sure this works for any of the --option_name, you just set npm_config_option_name, so we can just state it generically.

Also maybe worth mentioning that if you do npm config set option_name val then it only works if you run node-gyp through npm, but that if you do export npm_config_option_name=val or set npm_config_option_name=val then it works everywhere.

refack · 2017-04-27T23:18:13Z

@gibfahn PTAL

richardlau · 2017-04-28T06:02:52Z

README.md

+They can be set in two ways:
+1. via `npm config` - these work only when `node-gyp` is triggered by `npm`<br>
+   e.g. `$ npm config set npm_config_devdir /tmp/.gyp`
+2. as environment variables - work also when `noge-gyp` is invoked diretly<br>


Typos, noge-gyp->node-gyp and diretly->directly.

gibfahn · 2017-04-28T07:35:58Z

README.md

+1. via `npm config` - these work only when `node-gyp` is triggered by `npm`<br>
+   e.g. `$ npm config set npm_config_devdir /tmp/.gyp`
+2. as environment variables - work also when `noge-gyp` is invoked diretly<br>
+   e.g. `c:\> set npm_config_devdir=c:\temp\.gyp`


Maybe add an

$ export npm_config_devdir=/tmp/.gyp or
c:\> set npm_config_devdir=c:\temp\.gyp on Windows.

bnoordhuis · 2017-04-28T09:25:23Z

README.md

+Configuration
+--------
+
+#### `node-gyp` responds to configuration settings:


s/configuration settings/environment variables/? Also please insert a blank line.

I'm not sure either, but see if it works.

refack · 2017-04-28T12:12:04Z

@gibfahn @bnoordhuis @richardlau fixed. PTAL

gibfahn · 2017-04-28T12:20:34Z

README.md

+Configuration
+--------
+
+#### `node-gyp` responds to environment variables:


Still missing Ben's requested newline after this

bnoordhuis · 2017-04-28T12:25:14Z

README.md

+2. as environment variables - these work also when `node-gyp` is invoked
+ directly:<br>
+ `> set npm_config_devdir=c:\temp\.gyp` for Windows or<br>
+ `$ export npm_config_devdir=/tmp/.gyp` for unix like environments


A few remarks:

is the #### at the top necessary?

are the <br> tags necessary?

maybe s/triggered/executed/? 'triggered' is somewhat unspecific.

s/for example/For example/

s/unix like/UNIX-like/

insert a line or two explaining dashes should be replaced with underscores

is the #### at the top necessary?
In the other suctions the sub-title is followed by a table. I thought here it should be delineated in some way

maybe s/triggered/executed/? 'triggered' is somewhat unspecific.

npm -> node-gyp is sort of a trigger... but I changed it anyway.

gibfahn

Some more nits

gibfahn · 2017-04-28T12:23:14Z

README.md

+
+#### `node-gyp` responds to environment variables:
+Variables take the form `npm_config_OPTION_NAME` for any of the options
+listed above.<br>


Why the <br>? If you want a line break just add two trailing spaces (or leave a blank line between for a proper paragraph break). In any case I think the next line can be part of this one.

gibfahn · 2017-04-28T12:24:06Z

README.md

+listed above.<br>
+They can be set in two ways:
+1. as `npm` configuration - these work only when `node-gyp` is triggered by
+ `npm`. for example:<br>


gibfahn · 2017-04-28T12:24:27Z

README.md

+ `$ npm config set [--global] npm_config_devdir /tmp/.gyp`
+2. as environment variables - these work also when `node-gyp` is invoked
+ directly:<br>
+ `> set npm_config_devdir=c:\temp\.gyp` for Windows or<br>


gibfahn · 2017-04-28T12:24:42Z

README.md

+ `npm`. for example:<br>
+ `$ npm config set [--global] npm_config_devdir /tmp/.gyp`
+2. as environment variables - these work also when `node-gyp` is invoked
+ directly:<br>


gibfahn · 2017-04-28T12:26:23Z

README.md

+2. as environment variables - these work also when `node-gyp` is invoked
+ directly:<br>
+ `> set npm_config_devdir=c:\temp\.gyp` for Windows or<br>
+ `$ export npm_config_devdir=/tmp/.gyp` for unix like environments


I'd rather just have this as the default and then have the Windows one for Windows, that way people don't have to know whether they're in a Unix like environment, they just use default unless they're on Windows.

$ export npm_config_devdir=/tmp/.gyp or > set npm_config_devdir=c:\temp\.gyp for Windows

Wanted to mix it up for windows Falks #629, we tend to suffer most from node-gyp issues

I'm not saying that Windows is less important, just that I think it's clearer to have the Unix method as the default.

$ export npm_config_devdir=/tmp/.gyp or
> set npm_config_devdir=c:\temp\.gyp for Windows

If you're on a mac, you might not know that you're on a Unix-like environment. But you do know you're not on Windows, so you end up with the right command.

And FWIW any Unix user who wants to respect the $XDG_*_CONFIG spec will want to set this as well, which is one of the reasons this was actually implemented.

Changed.
(me 😭😭😭)

richardlau · 2017-04-28T13:11:15Z

README.md

+
+__`node-gyp` responds to environment variables:__
+Variables take the form `npm_config_OPTION_NAME` for any of the options
+listed above (dashes in option names should be replaced by an underscores).


addaleax · 2017-04-28T18:08:30Z

README.md

+They can be set in two ways:
+1. as `npm` configuration - these work only when `node-gyp` is executed by
+ `npm`. For example:  
+ `$ npm config set [--global] npm_config_devdir /tmp/.gyp`


Shouldn’t this be npm config set [--global] devdir /tmp/.gyp?

Great catch!
Shame on us...🤦

Fixes: nodejs#1180

refack · 2017-04-28T19:38:28Z

@richardlau @gibfahn Had rephrase for @addaleax's correction. PTAL.

gibfahn · 2017-05-13T12:00:13Z

@bnoordhuis LGTY?

refack · 2017-05-14T16:34:18Z

Just FMI was that a "Squash Merge". It looks really good on master.

addaleax · 2017-05-14T16:37:07Z

@refack there’s a lot of trailing whitespace here, btw… for next time :)

refack · 2017-05-14T17:13:49Z

@refack there’s a lot of trailing whitespace here, btw… for next time :)

Ack. I got used to my IDE trimming them, but it doesn't for markdown because they might be semantic.
That said all the trainings are intentional for formating, except for the one in line 199

refack force-pushed the patch-2 branch 6 times, most recently from b5a7585 to a005142 Compare April 27, 2017 23:17

richardlau requested changes Apr 28, 2017

View reviewed changes

gibfahn reviewed Apr 28, 2017

View reviewed changes

bnoordhuis requested changes Apr 28, 2017

View reviewed changes

refack force-pushed the patch-2 branch from a005142 to 2241896 Compare April 28, 2017 12:10

gibfahn reviewed Apr 28, 2017

View reviewed changes

bnoordhuis requested changes Apr 28, 2017

View reviewed changes

gibfahn suggested changes Apr 28, 2017

View reviewed changes

refack force-pushed the patch-2 branch from 2241896 to 0671788 Compare April 28, 2017 12:42

richardlau reviewed Apr 28, 2017

View reviewed changes

refack force-pushed the patch-2 branch from 0671788 to d117d34 Compare April 28, 2017 13:12

richardlau approved these changes Apr 28, 2017

View reviewed changes

refack force-pushed the patch-2 branch from d117d34 to 5db60bf Compare April 28, 2017 17:17

gibfahn approved these changes Apr 28, 2017

View reviewed changes

addaleax reviewed Apr 28, 2017

View reviewed changes

doc: blorb about setting npm_config_OPTION_NAME

8403816

Fixes: nodejs#1180

refack force-pushed the patch-2 branch from 5db60bf to 8403816 Compare April 28, 2017 19:37

addaleax approved these changes Apr 28, 2017

View reviewed changes

gibfahn approved these changes Apr 28, 2017

View reviewed changes

richardlau approved these changes Apr 28, 2017

View reviewed changes

gibfahn mentioned this pull request May 13, 2017

nodejs 'make install'ed headers are ignored #1191

Closed

bnoordhuis approved these changes May 14, 2017

View reviewed changes

gibfahn merged commit c307b30 into nodejs:master May 14, 2017

refack deleted the patch-2 branch May 14, 2017 16:24

This was referenced Jun 8, 2017

Initial gyp.js support #962

Closed

lib: add gyp.js support #1092

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: blorb about `npm_config_devdir` #1185

doc: blorb about `npm_config_devdir` #1185

refack commented Apr 27, 2017

gibfahn commented Apr 27, 2017

refack commented Apr 27, 2017

richardlau Apr 28, 2017

gibfahn Apr 28, 2017 •

edited

bnoordhuis Apr 28, 2017

refack Apr 28, 2017

refack commented Apr 28, 2017 •

edited

gibfahn Apr 28, 2017

bnoordhuis Apr 28, 2017

refack Apr 28, 2017

gibfahn left a comment

gibfahn Apr 28, 2017

gibfahn Apr 28, 2017

gibfahn Apr 28, 2017

gibfahn Apr 28, 2017

gibfahn Apr 28, 2017

refack Apr 28, 2017

gibfahn Apr 28, 2017 •

edited

refack Apr 28, 2017

richardlau Apr 28, 2017

addaleax Apr 28, 2017

refack Apr 28, 2017

refack commented Apr 28, 2017

gibfahn commented May 13, 2017

refack commented May 14, 2017

addaleax commented May 14, 2017

refack commented May 14, 2017

doc: blorb about npm_config_devdir #1185

doc: blorb about npm_config_devdir #1185

Conversation

refack commented Apr 27, 2017

gibfahn commented Apr 27, 2017

refack commented Apr 27, 2017

Choose a reason for hiding this comment

gibfahn Apr 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Apr 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gibfahn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gibfahn Apr 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Apr 28, 2017

gibfahn commented May 13, 2017

refack commented May 14, 2017

addaleax commented May 14, 2017

refack commented May 14, 2017

doc: blorb about `npm_config_devdir` #1185

doc: blorb about `npm_config_devdir` #1185

gibfahn Apr 28, 2017 •

edited

refack commented Apr 28, 2017 •

edited

gibfahn Apr 28, 2017 •

edited