From 1b8c6f266ff8ae9722296fd8cc7fd752613e1cee Mon Sep 17 00:00:00 2001 From: Vitor Dino Date: Fri, 8 Sep 2023 15:19:29 -0300 Subject: docs: fix `--backend` options list on cache.md (#4599) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `symlink` wasn’t an item, it appeared the same as `copyfile` --- docs/install/cache.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/install') diff --git a/docs/install/cache.md b/docs/install/cache.md index bb22e545d..37cdc1a68 100644 --- a/docs/install/cache.md +++ b/docs/install/cache.md @@ -46,7 +46,7 @@ This behavior is configurable with the `--backend` flag, which is respected by a - **`clonefile`** Default on macOS. - **`clonefile_each_dir`**: Similar to `clonefile`, except it clones each file individually per directory. It is only available on macOS and tends to perform slower than `clonefile`. - **`copyfile`**: The fallback used when any of the above fail. It is the slowest option. On macOS, it uses `fcopyfile()`; on Linux it uses `copy_file_range()`. - **`symlink`**: Currently used only `file:` (and eventually `link:`) dependencies. To prevent infinite loops, it skips symlinking the `node_modules` folder. +- **`symlink`**: Currently used only `file:` (and eventually `link:`) dependencies. To prevent infinite loops, it skips symlinking the `node_modules` folder. If you install with `--backend=symlink`, Node.js won't resolve node_modules of dependencies unless each dependency has its own `node_modules` folder or you pass `--preserve-symlinks` to `node`. See [Node.js documentation on `--preserve-symlinks`](https://nodejs.org/api/cli.html#--preserve-symlinks). -- cgit v1.2.3