summaryrefslogtreecommitdiff
path: root/deps/npm/doc
diff options
context:
space:
mode:
authorForrest L Norvell <forrest@npmjs.com>2015-01-17 00:50:09 -0800
committerBen Noordhuis <info@bnoordhuis.nl>2015-01-18 13:51:49 +0100
commit9dc8f59fea5a294df039f70e523be2d45aef1324 (patch)
tree69fbaf54182ccf04626781d330ead12d185421bc /deps/npm/doc
parente8ad773b56a94fad2cd8a454453a7214a8ce92d1 (diff)
downloadnode-new-9dc8f59fea5a294df039f70e523be2d45aef1324.tar.gz
deps: upgrade npm to 2.2.0
PR-URL: https://github.com/iojs/io.js/pull/479 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Rod Vagg <rod@vagg.org>
Diffstat (limited to 'deps/npm/doc')
-rw-r--r--deps/npm/doc/api/npm-tag.md2
-rw-r--r--deps/npm/doc/api/npm.md4
-rw-r--r--deps/npm/doc/cli/npm-run-script.md9
-rw-r--r--deps/npm/doc/cli/npm-tag.md24
-rw-r--r--deps/npm/doc/cli/npm-update.md4
-rw-r--r--deps/npm/doc/cli/npm.md4
-rw-r--r--deps/npm/doc/files/package.json.md2
-rw-r--r--deps/npm/doc/misc/npm-index.md4
8 files changed, 41 insertions, 12 deletions
diff --git a/deps/npm/doc/api/npm-tag.md b/deps/npm/doc/api/npm-tag.md
index b5a3d7faa6..9cda0c407d 100644
--- a/deps/npm/doc/api/npm-tag.md
+++ b/deps/npm/doc/api/npm-tag.md
@@ -18,6 +18,6 @@ is the package name and version is the version number (much like installing a
specific version).
The second element is the name of the tag to tag this version with. If this
-parameter is missing or falsey (empty), the default froom the config will be
+parameter is missing or falsey (empty), the default from the config will be
used. For more information about how to set this config, check
`man 3 npm-config` for programmatic usage or `man npm-config` for cli usage.
diff --git a/deps/npm/doc/api/npm.md b/deps/npm/doc/api/npm.md
index 4b4dfcaddd..611292ec94 100644
--- a/deps/npm/doc/api/npm.md
+++ b/deps/npm/doc/api/npm.md
@@ -1,5 +1,5 @@
-npm(3) -- node package manager
-==============================
+npm(3) -- javascript package manager
+====================================
## SYNOPSIS
diff --git a/deps/npm/doc/cli/npm-run-script.md b/deps/npm/doc/cli/npm-run-script.md
index 74f416e0be..c218c845f5 100644
--- a/deps/npm/doc/cli/npm-run-script.md
+++ b/deps/npm/doc/cli/npm-run-script.md
@@ -11,10 +11,13 @@ npm-run-script(1) -- Run arbitrary package scripts
This runs an arbitrary command from a package's `"scripts"` object.
If no package name is provided, it will search for a `package.json`
in the current folder and use its `"scripts"` object. If no `"command"`
-is provided, it will list the available top level scripts.
+is provided, it will list the available top level scripts. The `env` command
+can be used to list environment variables that will be available to the script
+at runtime. If an "env" command is defined in your package it will have
+precedence instead.
-It is used by the test, start, restart, and stop commands, but can be
-called directly, as well.
+`run[-script]` is used by the test, start, restart, and stop commands, but can
+be called directly, as well.
As of [`npm@2.0.0`](http://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
use custom arguments when executing scripts. The special option `--` is used by
diff --git a/deps/npm/doc/cli/npm-tag.md b/deps/npm/doc/cli/npm-tag.md
index 3e1d1051bd..28a1c9334f 100644
--- a/deps/npm/doc/cli/npm-tag.md
+++ b/deps/npm/doc/cli/npm-tag.md
@@ -23,6 +23,29 @@ This also applies to `npm dedupe`.
Publishing a package always sets the "latest" tag to the published version.
+## PURPOSE
+
+Tags can be used to provide an alias instead of version numbers. For
+example, `npm` currently uses the tag "next" to identify the upcoming
+version, and the tag "latest" to identify the current version.
+
+A project might choose to have multiple streams of development, e.g.,
+"stable", "canary".
+
+## CAVEATS
+
+Tags must share a namespace with version numbers, because they are
+specified in the same slot: `npm install <pkg>@<version>` vs `npm
+install <pkg>@<tag>`.
+
+Tags that can be interpreted as valid semver ranges will be
+rejected. For example, `v1.4` cannot be used as a tag, because it is
+interpreted by semver as `>=1.4.0 <1.5.0`. See
+<https://github.com/npm/npm/issues/6082>.
+
+The simplest way to avoid semver problems with tags is to use tags
+that do not begin with a number or the letter `v`.
+
## SEE ALSO
* npm-publish(1)
@@ -31,4 +54,5 @@ Publishing a package always sets the "latest" tag to the published version.
* npm-registry(7)
* npm-config(1)
* npm-config(7)
+* npm-tag(3)
* npmrc(5)
diff --git a/deps/npm/doc/cli/npm-update.md b/deps/npm/doc/cli/npm-update.md
index a53d294592..2aa0f366bc 100644
--- a/deps/npm/doc/cli/npm-update.md
+++ b/deps/npm/doc/cli/npm-update.md
@@ -10,7 +10,9 @@ npm-update(1) -- Update a package
This command will update all the packages listed to the latest version
(specified by the `tag` config).
-It will also install missing packages.
+It will also install missing packages. As with all commands that install
+packages, the `--dev` flag will cause `devDependencies` to be processed
+as well.
If the `-g` flag is specified, this command will update globally installed
packages.
diff --git a/deps/npm/doc/cli/npm.md b/deps/npm/doc/cli/npm.md
index ad16d419e8..331a03577b 100644
--- a/deps/npm/doc/cli/npm.md
+++ b/deps/npm/doc/cli/npm.md
@@ -1,5 +1,5 @@
-npm(1) -- node package manager
-==============================
+npm(1) -- javascript package manager
+====================================
## SYNOPSIS
diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md
index e23f7affc7..00939cbf49 100644
--- a/deps/npm/doc/files/package.json.md
+++ b/deps/npm/doc/files/package.json.md
@@ -28,7 +28,7 @@ The name is what your thing is called. Some tips:
* The name will probably be passed as an argument to require(), so it should
be something short, but also reasonably descriptive.
* You may want to check the npm registry to see if there's something by that name
- already, before you get too attached to it. http://registry.npmjs.org/
+ already, before you get too attached to it. <https://www.npmjs.com/>
A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See
`npm-scope(7)` for more detail.
diff --git a/deps/npm/doc/misc/npm-index.md b/deps/npm/doc/misc/npm-index.md
index a68ac30c97..96c62cced6 100644
--- a/deps/npm/doc/misc/npm-index.md
+++ b/deps/npm/doc/misc/npm-index.md
@@ -11,7 +11,7 @@ Using npm on the command line
### npm(1)
-node package manager
+javascript package manager
### npm-adduser(1)
@@ -199,7 +199,7 @@ Using npm in your Node programs
### npm(3)
-node package manager
+javascript package manager
### npm-bin(3)