diff options
| author | Kat Marchán <kzm@sykosomatic.org> | 2016-03-18 01:54:10 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@sykosomatic.org> | 2016-03-18 01:54:41 +0300 |
| commit | df2cc02fafbb31f6257f686c652d34049d5faddc (patch) | |
| tree | fd6febc33f8e86b309f91add9eb6782c3cb4431b | |
| parent | 98a9ee4773f83994b8eb63c0ff75a9283408ba1a (diff) | |
doc: fix small detail in npm-link docs
This corrects a minor thing that popped up while reviewing
https://github.com/npm/npm/pull/11820
Credit: @zkat
Reviewed-By: @iarna
| -rw-r--r-- | doc/cli/npm-link.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/cli/npm-link.md b/doc/cli/npm-link.md index 3ee0436c4..1f3d63a0d 100644 --- a/doc/cli/npm-link.md +++ b/doc/cli/npm-link.md @@ -11,9 +11,9 @@ npm-link(1) -- Symlink a package folder Package linking is a two-step process. -First, `npm link` in a package folder will create a symlink from -the local `node_modules` folder to the global folder `{prefix}/lib/node_modules/` -(see `npm-config(7)` for the value of `prefix`). +First, `npm link` in a package folder will create a symlink in the global folder +`{prefix}/lib/node_modules/<package>` that links to the package where the `npm +link` command was executed. (see `npm-config(7)` for the value of `prefix`). Next, in some other location, `npm link package-name` will create a symbolic link from globally-installed `package-name` to `node_modules/` @@ -40,7 +40,7 @@ For example: Now, any changes to ~/projects/node-redis will be reflected in ~/projects/node-bloggy/node_modules/node-redis/. Note that the link should -be to the package name, not the directory name for that package. +be to the package name, not the directory name for that package. You may also shortcut the two steps in one. For example, to do the above use-case in a shorter way: |