Document the 'dev' config

npm · Aug 10, 2010 · 6f7987b · 6f7987b
1 parent 864dcd3
commit 6f7987b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/config.md b/doc/config.md
@@ -161,3 +161,10 @@ If set to some truish value (for instance, by being the last cli flag or being
 passed a literal `true` or `1`), and the `npm config set` param is being
 called, then the new configuration paramater is written global config file.
 Otherwise, they are saved to the user config file.
+
+### dev
+
+If set to a truish value, then it'll install the "devDependencies" as well as
+"dependencies" when installing a package.
+
+Note that devDependencies are *always* installed when linking a package.
diff --git a/man/config.1 b/man/config.1
@@ -191,3 +191,9 @@ Note that this must be provided in the cli, env, or userconfig settings\. Once t
 .
 .SS "global"
 If set to some truish value (for instance, by being the last cli flag or being passed a literal \fBtrue\fR or \fB1\fR), and the \fBnpm config set\fR param is being called, then the new configuration paramater is written global config file\. Otherwise, they are saved to the user config file\.
+.
+.SS "dev"
+If set to a truish value, then it\'ll install the "devDependencies" as well as "dependencies" when installing a package\.
+.
+.P
+Note that devDependencies are \fIalways\fR installed when linking a package\.