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: add command options to README.md #937

Closed
wants to merge 2 commits into from
Closed

Conversation

gibfahn
Copy link
Member

@gibfahn gibfahn commented May 23, 2016

Documents options accepted by node-gyp.
Continuation of #880.

@bnoordhuis

@Fishrock123
Copy link
Contributor

I feel like this is missing some options, also CC @bnoordhuis

@bnoordhuis
Copy link
Member

Can you split it into two commits? The new flag looks alright but a code change should not be part of a documentation commit.

Also, @Fishrock123 is right that there are plenty more options: --arch, --python, --dist-url=, etc.

@gibfahn
Copy link
Member Author

gibfahn commented May 24, 2016

Looking at lib/node-gyp.js, it looks like these are all options. I'll try to get examples added for all of them.

    help: Boolean     // everywhere
  , arch: String      // 'configure'
  , cafile: String    // 'install'
  , debug: Boolean    // 'build'
  , directory: String // bin
  , make: String      // 'build'
  , msvs_version: String // 'configure'
  , ensure: Boolean   // 'install'
  , solution: String  // 'build' (windows only)
  , proxy: String     // 'install'
  , nodedir: String   // 'configure'
  , loglevel: String  // everywhere
  , python: String    // 'configure'
  , 'dist-url': String // 'install'
  , 'tarball': String // 'install'
  , jobs: String      // 'build'
  , thin: String      // 'configure'

And these abbreviations:

    release: '--no-debug'
  , C: '--directory'
  , debug: '--debug'
  , j: '--jobs'
  , silly: '--loglevel=silly'
  , verbose: '--loglevel=verbose'

@gibfahn gibfahn force-pushed the docs-fix branch 2 times, most recently from 9081f6c to 09311f4 Compare May 24, 2016 11:01
Passing --silent is equivalent to passing --loglevel=silent.
@gibfahn gibfahn force-pushed the docs-fix branch 6 times, most recently from 2bf72c4 to 514e50a Compare May 24, 2016 12:08
@gibfahn
Copy link
Member Author

gibfahn commented May 31, 2016

@bnoordhuis updated, PTAL

| `--cafile=$cafile` | Override default CA chain (to download tarball)
| `--nodedir=$path` | Set the path to the node binary
| `--python=$path` | Set path to the python (2) binary
| `--msys_version=$version` | Set Visual Studio version (win)
Copy link
Member

Choose a reason for hiding this comment

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

Typo? I think you mean --msvs_version=$version?

Documents options accepted by node-gyp.
Continuation of nodejs#880.
bnoordhuis pushed a commit that referenced this pull request May 31, 2016
Passing --silent is equivalent to passing --loglevel=silent.

PR-URL: #937
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
bnoordhuis pushed a commit that referenced this pull request May 31, 2016
Documents options accepted by node-gyp.

PR-URL: #937
Refs: #880
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@bnoordhuis
Copy link
Member

Thanks Gibson, landed in ac29d23...4ee3132.

@bnoordhuis bnoordhuis closed this May 31, 2016
@rvagg rvagg mentioned this pull request Jun 14, 2016
zkat pushed a commit to npm/npm that referenced this pull request Jun 29, 2016
Headline items:
 * Fix for Visual Studio 2015 __pfnDliNotifyHook2 failures nodejs/node-gyp#952
 * Fix for AIX using fs.statSync nodejs/node-gyp#955
 * More verbose msbuild.exe missing error output https://github.com/nodejs/node-gyp/pull/930/files
 * Added --silent for --loglevel=silent nodejs/node-gyp#937
 * Enable V8 deprecation warnings for native addons nodejs/node-gyp#920

Full changelog at https://github.com/nodejs/node-gyp/blob/master/CHANGELOG.md

Credit: @rvagg
PR-URL: #13199
Reviewed-By: @zkat
zkat pushed a commit to npm/npm that referenced this pull request Jun 29, 2016
Headline items:
 * Fix for Visual Studio 2015 __pfnDliNotifyHook2 failures nodejs/node-gyp#952
 * Fix for AIX using fs.statSync nodejs/node-gyp#955
 * More verbose msbuild.exe missing error output https://github.com/nodejs/node-gyp/pull/930/files
 * Added --silent for --loglevel=silent nodejs/node-gyp#937
 * Enable V8 deprecation warnings for native addons nodejs/node-gyp#920

Full changelog at https://github.com/nodejs/node-gyp/blob/master/CHANGELOG.md

Credit: @rvagg
PR-URL: #13200
Reviewed-By: @zkat
zkat pushed a commit to npm/npm that referenced this pull request Jun 29, 2016
Headline items:
 * Fix for Visual Studio 2015 __pfnDliNotifyHook2 failures nodejs/node-gyp#952
 * Fix for AIX using fs.statSync nodejs/node-gyp#955
 * More verbose msbuild.exe missing error output https://github.com/nodejs/node-gyp/pull/930/files
 * Added --silent for --loglevel=silent nodejs/node-gyp#937
 * Enable V8 deprecation warnings for native addons nodejs/node-gyp#920

Full changelog at https://github.com/nodejs/node-gyp/blob/master/CHANGELOG.md

Credit: @rvagg
PR-URL: #13199
Reviewed-By: @zkat
zkat pushed a commit to npm/npm that referenced this pull request Jun 30, 2016
Headline items:
 * Fix for Visual Studio 2015 __pfnDliNotifyHook2 failures nodejs/node-gyp#952
 * Fix for AIX using fs.statSync nodejs/node-gyp#955
 * More verbose msbuild.exe missing error output https://github.com/nodejs/node-gyp/pull/930/files
 * Added --silent for --loglevel=silent nodejs/node-gyp#937
 * Enable V8 deprecation warnings for native addons nodejs/node-gyp#920

Full changelog at https://github.com/nodejs/node-gyp/blob/master/CHANGELOG.md

Credit: @rvagg
PR-URL: #13199
Reviewed-By: @zkat
@gibfahn gibfahn deleted the docs-fix branch December 28, 2016 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants