diff options
| author | Martin von Gagern <Martin.vGagern@gmx.net> | 2016-01-09 01:37:05 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2016-01-29 01:58:45 +0300 |
| commit | 39dea9ca4216c6ea628f5ca47d2b34a4b251a1ed (patch) | |
| tree | 343d71413d3e89c9a8465051098c078d0f3287b1 /doc | |
| parent | 6803fedadb8f9b36cd85f7338ecf75d1d183c833 (diff) | |
add-remote-git: Add support for git submodules in git remotes
This is a fairly simple approach, which does not leverage the git caching
mechansim to cache submodules. It also doesn't provide a means to disable
automatic initialization, e.g. via a setting in the .gitmodules file.
This also adds documentation for the git+file protocol, since we have
a test case ensuring that this works. We have no test case for the
git+rsync protocol, even though npm-package-arg seems to have support
for that as well, so that wasn't added to the documentation.
PR-URL: https://github.com/npm/npm/pull/11094
Credit: @gagern
Reviewed-By: @othiym23
Fixes: #1876
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-install.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/cli/npm-install.md b/doc/cli/npm-install.md index fed452b3d..efeb23e33 100644 --- a/doc/cli/npm-install.md +++ b/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: |