Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorForrest L Norvell <forrest@npmjs.com>2015-08-15 04:21:13 +0300
committerForrest L Norvell <forrest@npmjs.com>2015-09-09 02:48:11 +0300
commit2fb60bfef323d8dcf8f8c972bcb8e4d167e5e25d (patch)
tree39a5f18a3e2705a899c914e8c1e40a627a4eb40e /doc/api/npm-link.md
parentb064c40b16c2c2c318ada2f502069002ba074e2c (diff)
doc: remove misleading API documentation
The API is awkward, brittle, and frequently counterintuitive. Having it documented sets an unrealistic expectation of it being a supported / encouraged thing for developers outside the team to use. Until we have an API we should stand behind, having it be undocumented is actually a net win because people won't be misled into thinking they're gonna have a good time by using it.
Diffstat (limited to 'doc/api/npm-link.md')
-rw-r--r--doc/api/npm-link.md33
1 files changed, 0 insertions, 33 deletions
diff --git a/doc/api/npm-link.md b/doc/api/npm-link.md
deleted file mode 100644
index fe875ec60..000000000
--- a/doc/api/npm-link.md
+++ /dev/null
@@ -1,33 +0,0 @@
-npm-link(3) -- Symlink a package folder
-=======================================
-
-## SYNOPSIS
-
- npm.commands.link(callback)
- npm.commands.link(packages, callback)
-
-## DESCRIPTION
-
-Package linking is a two-step process.
-
-Without parameters, link will create a globally-installed
-symbolic link from `prefix/package-name` to the current folder.
-
-With a parameters, link will create a symlink from the local `node_modules`
-folder to the global symlink.
-
-When creating tarballs for `npm publish`, the linked packages are
-"snapshotted" to their current state by resolving the symbolic links.
-
-This is
-handy for installing your own stuff, so that you can work on it and test it
-iteratively without having to continually rebuild.
-
-For example:
-
- npm.commands.link(cb) # creates global link from the cwd
- # (say redis package)
- npm.commands.link('redis', cb) # link-install the package
-
-Now, any changes to the redis package will be reflected in
-the package in the current working directory