Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update misleading clonefile information #7388

Merged
merged 4 commits into from
Dec 5, 2023
Merged

docs: update misleading clonefile information #7388

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c24456c
docs: update misleading `clonefile` information
ImBIOS Dec 1, 2023
c7e0d27
Merge branch 'main' into patch-9
ImBIOS Dec 1, 2023
de2d524
Fix macOS exception in cache module
ImBIOS Dec 1, 2023
de1018c
Merge branch 'main' into patch-9
ImBIOS Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/install/cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Once a package is downloaded into the cache, Bun still needs to copy those files

Since Bun uses hardlinks to "copy" a module into a project's `node_modules` directory on Linux, the contents of the package only exist in a single location on disk, greatly reducing the amount of disk space dedicated to `node_modules`.

This benefit does not extend to macOS, which uses `clonefile` for performance reasons.
This benefit also applies to macOS, but there are exceptions. It uses `clonefile` which is copy-on-write, meaning it will not occupy disk space, but it will count towards drive's limit. This behavior is useful if something attempts to patch `node_modules/*`, so it's impossible to affect other installations.

{% details summary="Installation strategies" %}
This behavior is configurable with the `--backend` flag, which is respected by all of Bun's package management commands.
Expand Down