0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/deps/npm/man/man3/submodule.3
2012-12-12 14:41:28 -08:00

43 lines
1.1 KiB
Groff

.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-SUBMODULE" "3" "December 2012" "" ""
.
.SH "NAME"
\fBnpm-submodule\fR \-\- Add a package as a git submodule
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.submodule(packages, callback)
.
.fi
.
.SH "DESCRIPTION"
For each package specified, npm will check if it has a git repository url
in its package\.json description then add it as a git submodule at \fBnode_modules/<pkg name>\fR\|\.
.
.P
This is a convenience only\. From then on, it\'s up to you to manage
updates by using the appropriate git commands\. npm will stubbornly
refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder
in it\.
.
.P
This command also does not install missing dependencies, if the package
does not include them in its git repository\. If \fBnpm ls\fR reports that
things are missing, you can either install, link, or submodule them yourself,
or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the
dependencies into the submodule folder\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm help json
.
.IP "\(bu" 4
git help submodule
.
.IP "" 0