summaryrefslogtreecommitdiff
path: root/deps/npm/doc
diff options
context:
space:
mode:
authorKat Marchán <kzm@sykosomatic.org>2016-02-22 11:59:14 -0800
committerMyles Borins <mborins@us.ibm.com>2016-03-07 15:20:36 -0800
commit4ed038808f7bb78cc00fce6162b3f71b45abbd66 (patch)
tree0fc314b5f3e9d64862fddf5bdee7765050527b7c /deps/npm/doc
parent061ebb39c94eea22d34d20c6936787310f7bf9b0 (diff)
downloadnode-new-4ed038808f7bb78cc00fce6162b3f71b45abbd66.tar.gz
deps: upgrade to npm 3.7.3
PR-URL: https://github.com/nodejs/node/pull/5369 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
Diffstat (limited to 'deps/npm/doc')
-rw-r--r--deps/npm/doc/cli/npm-install.md9
-rw-r--r--deps/npm/doc/cli/npm-shrinkwrap.md12
-rw-r--r--deps/npm/doc/cli/npm-update.md58
-rw-r--r--deps/npm/doc/cli/npm-view.md5
-rw-r--r--deps/npm/doc/files/package.json.md12
-rw-r--r--deps/npm/doc/misc/npm-config.md2
6 files changed, 51 insertions, 47 deletions
diff --git a/deps/npm/doc/cli/npm-install.md b/deps/npm/doc/cli/npm-install.md
index 36566af0df..eca4e2c3bf 100644
--- a/deps/npm/doc/cli/npm-install.md
+++ b/deps/npm/doc/cli/npm-install.md
@@ -169,9 +169,12 @@ after packing it up into a tarball (b).
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish>]
- `<protocol>` is one of `git`, `git+ssh`, `git+http`, or
- `git+https`. If no `<commit-ish>` is specified, then `master` is
- used.
+ `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`,
+ or `git+file`.
+ If no `<commit-ish>` is specified, then `master` is used.
+
+ If the repository makes use of submodules, those submodules will
+ be cloned as well.
The following git environment variables are recognized by npm and will be added
to the environment when running git:
diff --git a/deps/npm/doc/cli/npm-shrinkwrap.md b/deps/npm/doc/cli/npm-shrinkwrap.md
index 5156d339a7..c79418a248 100644
--- a/deps/npm/doc/cli/npm-shrinkwrap.md
+++ b/deps/npm/doc/cli/npm-shrinkwrap.md
@@ -82,16 +82,16 @@ This generates `npm-shrinkwrap.json`, which will look something like this:
{
"name": "A",
- "version": "1.1.0",
+ "version": "0.1.0",
"dependencies": {
"B": {
- "version": "1.0.1",
- "from": "B@^1.0.0",
- "resolved": "https://registry.npmjs.org/B/-/B-1.0.1.tgz",
+ "version": "0.0.1",
+ "from": "B@^0.0.1",
+ "resolved": "https://registry.npmjs.org/B/-/B-0.0.1.tgz",
"dependencies": {
"C": {
- "version": "1.0.1",
- "from": "org/C#v1.0.1",
+ "version": "0.0.1",
+ "from": "org/C#v0.0.1",
"resolved": "git://github.com/org/C.git#5c380ae319fc4efe9e7f2d9c78b0faa588fd99b4"
}
}
diff --git a/deps/npm/doc/cli/npm-update.md b/deps/npm/doc/cli/npm-update.md
index f79752fae9..5271ac16d3 100644
--- a/deps/npm/doc/cli/npm-update.md
+++ b/deps/npm/doc/cli/npm-update.md
@@ -22,16 +22,7 @@ or local) will be updated.
As of `npm@2.6.1`, the `npm update` will only inspect top-level packages.
Prior versions of `npm` would also recursively inspect all dependencies.
-To get the old behavior, use `npm --depth Infinity update`, but be warned that
-simultaneous asynchronous update of all packages, including `npm` itself
-and packages that `npm` depends on, often causes problems up to and including
-the uninstallation of `npm` itself.
-
-To restore a missing `npm`, use the command:
-
-```
-curl -L https://npmjs.com/install.sh | sh
-```
+To get the old behavior, use `npm --depth Infinity update`.
## EXAMPLES
@@ -44,16 +35,17 @@ on dependencies, `dep1` (`dep2`, .. etc.). The published versions of `dep1` are
```
{
- dist-tags: { latest: "1.2.2" },
- versions: { "1.2.2",
- "1.2.1",
- "1.2.0",
- "1.1.2",
- "1.1.1",
- "1.0.0",
- "0.4.1",
- "0.4.0",
- "0.2.0"
+ "dist-tags": { "latest": "1.2.2" },
+ "versions": {
+ "1.2.2",
+ "1.2.1",
+ "1.2.0",
+ "1.1.2",
+ "1.1.1",
+ "1.0.0",
+ "0.4.1",
+ "0.4.0",
+ "0.2.0"
}
}
```
@@ -63,8 +55,8 @@ on dependencies, `dep1` (`dep2`, .. etc.). The published versions of `dep1` are
If `app`'s `package.json` contains:
```
-dependencies: {
- dep1: "^1.1.1"
+"dependencies": {
+ "dep1": "^1.1.1"
}
```
@@ -76,8 +68,8 @@ Then `npm update` will install `dep1@1.2.2`, because `1.2.2` is `latest` and
However, if `app`'s `package.json` contains:
```
-dependencies: {
- dep1: "~1.1.1"
+"dependencies": {
+ "dep1": "~1.1.1"
}
```
@@ -91,8 +83,8 @@ which is `1.1.2`.
Suppose `app` has a caret dependency on a version below `1.0.0`, for example:
```
-dependencies: {
- dep1: "^0.2.0"
+"dependencies": {
+ "dep1": "^0.2.0"
}
```
@@ -102,8 +94,8 @@ versions which satisfy `^0.2.0`.
If the dependence were on `^0.4.0`:
```
-dependencies: {
- dep1: "^0.4.0"
+"dependencies": {
+ "dep1": "^0.4.0"
}
```
@@ -118,8 +110,8 @@ the minimum required dependency in `package.json`, you can use
`package.json` contains:
```
-dependencies: {
- dep1: "^1.1.1"
+"dependencies": {
+ "dep1": "^1.1.1"
}
```
@@ -127,8 +119,8 @@ Then `npm update --save` will install `dep1@1.2.2` (i.e., `latest`),
and `package.json` will be modified:
```
-dependencies: {
- dep1: "^1.2.2"
+"dependencies": {
+ "dep1": "^1.2.2"
}
```
@@ -137,7 +129,7 @@ if it installs a new package.
### Updating Globally-Installed Packages
-`npm update -g` will apply the `update` action to each globally- installed
+`npm update -g` will apply the `update` action to each globally installed
package that is `outdated` -- that is, has a version that is different from
`latest`.
diff --git a/deps/npm/doc/cli/npm-view.md b/deps/npm/doc/cli/npm-view.md
index 2215818a45..35e42adf9a 100644
--- a/deps/npm/doc/cli/npm-view.md
+++ b/deps/npm/doc/cli/npm-view.md
@@ -67,6 +67,11 @@ was required by each matching version of yui3:
npm view yui3@'>0.5.4' dependencies.jsdom
+To show the `connect` package version history, you can do
+this:
+
+ npm view connect versions
+
## OUTPUT
If only a single string field for a single version is output, then it
diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md
index 4b278e1324..50d268f32d 100644
--- a/deps/npm/doc/files/package.json.md
+++ b/deps/npm/doc/files/package.json.md
@@ -113,7 +113,7 @@ expression syntax version 2.0 string](https://npmjs.com/package/spdx), like this
{ "license" : "(ISC OR GPL-3.0)" }
If you are using a license that hasn't been assigned an SPDX identifier, or if
-you are using a custom license, use the following valid SPDX expression:
+you are using a custom license, use a string value like this one:
{ "license" : "SEE LICENSE IN <filename>" }
@@ -186,9 +186,12 @@ works just like a `.gitignore`.
Certain files are always included, regardless of settings:
* `package.json`
-* `README` (and its variants)
-* `CHANGELOG` (and its variants)
+* `README`
+* `CHANGES` / `CHANGELOG` / `HISTORY`
* `LICENSE` / `LICENCE`
+* The file in the "main" field
+
+`README`, `CHANGES` & `LICENSE` can have any case and extension.
Conversely, some files are always ignored:
@@ -198,10 +201,11 @@ Conversely, some files are always ignored:
* `.hg`
* `.lock-wscript`
* `.wafpickle-N`
-* `*.swp`
+* `.*.swp`
* `.DS_Store`
* `._*`
* `npm-debug.log`
+* `.npmrc`
## main
diff --git a/deps/npm/doc/misc/npm-config.md b/deps/npm/doc/misc/npm-config.md
index a3c7b5a506..3d10ddf882 100644
--- a/deps/npm/doc/misc/npm-config.md
+++ b/deps/npm/doc/misc/npm-config.md
@@ -394,7 +394,7 @@ Causes npm to install the package into your local `node_modules` folder with
the same layout it uses with the global `node_modules` folder. Only your
direct dependencies will show in `node_modules` and everything they depend
on will be flattened in their `node_modules` folders. This obviously will
-elminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be
+eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be
preferred.
### group