update folders doc

npm · Aug 12, 2010 · 319b63a · 319b63a
1 parent e7d403e
commit 319b63a
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 5 deletions.
diff --git a/doc/folders.md b/doc/folders.md
@@ -17,6 +17,22 @@ appropriately.
 
 `root/.npm/foo/active` symlink to the active version.
 
-`root/foo-1.0.0.js` symlink to `.npm/foo/1.0.0/main.js`
+`root/foo-1.0.0.js` shim to `.npm/foo/1.0.0/main.js`
 
-`root/foo.js` symlink to `.npm/foo/active/main.js`
+`root/foo.js` shim to `.npm/foo/active/main.js`
+
+`root/.npm/foo/1.0.0/dependencies` links to the modules that foo depends upon.
+This is loaded into the require path first in the foo shims.
+
+`root/.npm/foo/1.0.0/dependson` links to the package folders that foo depends
+on.  This is here so that npm can access those packages programmatically.
+
+`root/.npm/foo/1.0.0/dependents` links to the packages that depend upon foo.
+
+`root/.npm/.cache` the cache folder.
+
+`root/.npm/.cache/foo/1.0.0/package.json` the parsed package.json for foo@1.0.0
+
+`root/.npm/.cache/foo/1.0.0/package.tgz` the tarball of foo@1.0.0
+
+`root/.npm/.cache/foo/1.0.0/package` the untouched pristine copy of foo@1.0.0
diff --git a/man/folders.1 b/man/folders.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "NPM\-FOLDERS" "1" "July 2010" "" ""
+.TH "NPM\-FOLDERS" "1" "August 2010" "" ""
 .
 .SH "NAME"
 \fBnpm\-folders\fR \- Folder Structures Used by npm
@@ -22,7 +22,28 @@ Everything lives in the \fBroot\fR setting\. Check \fBnpm help config\fR for mor
 \fBroot/\.npm/foo/active\fR symlink to the active version\.
 .
 .P
-\fBroot/foo\-1\.0\.0\.js\fR symlink to \fB\.npm/foo/1\.0\.0/main\.js\fR
+\fBroot/foo\-1\.0\.0\.js\fR shim to \fB\.npm/foo/1\.0\.0/main\.js\fR
 .
 .P
-\fBroot/foo\.js\fR symlink to \fB\.npm/foo/active/main\.js\fR
+\fBroot/foo\.js\fR shim to \fB\.npm/foo/active/main\.js\fR
+.
+.P
+\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\. This is loaded into the require path first in the foo shims\.
+.
+.P
+\fBroot/\.npm/foo/1\.0\.0/dependson\fR links to the package folders that foo depends on\. This is here so that npm can access those packages programmatically\.
+.
+.P
+\fBroot/\.npm/foo/1\.0\.0/dependents\fR links to the packages that depend upon foo\.
+.
+.P
+\fBroot/\.npm/\.cache\fR the cache folder\.
+.
+.P
+\fBroot/\.npm/\.cache/foo/1\.0\.0/package\.json\fR the parsed package\.json for foo@1\.0\.0
+.
+.P
+\fBroot/\.npm/\.cache/foo/1\.0\.0/package\.tgz\fR the tarball of foo@1\.0\.0
+.
+.P
+\fBroot/\.npm/\.cache/foo/1\.0\.0/package\fR the untouched pristine copy of foo@1\.0\.0