deps/npm/man/man1/npm-submodule.1

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-SUBMODULE" "1" "December 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-submodule\fR \-\- Add a package as a git submodule
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm submodule <pkg>
  13 .
  14 .fi
  15 .
  16 .SH "DESCRIPTION"
  17 If the specified package has a git repository url in its package\.json
  18 description, then this command will add it as a git submodule at \fBnode_modules/<pkg name>\fR\|\.
  19 .
  20 .P
  21 This is a convenience only\.  From then on, it\'s up to you to manage
  22 updates by using the appropriate git commands\.  npm will stubbornly
  23 refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder
  24 in it\.
  25 .
  26 .P
  27 This command also does not install missing dependencies, if the package
  28 does not include them in its git repository\.  If \fBnpm ls\fR reports that
  29 things are missing, you can either install, link, or submodule them yourself,
  30 or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the
  31 dependencies into the submodule folder\.
  32 .
  33 .SH "SEE ALSO"
  34 .
  35 .IP "\(bu" 4
  36 npm help  package\.json
  37 .
  38 .IP "\(bu" 4
  39 git help submodule
  40 .
  41 .IP "" 0
  42