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.

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

Conversation

ImBIOS
Copy link
Contributor

@ImBIOS ImBIOS commented Dec 1, 2023

What does this PR do?

Close #5973

  • Documentation or TypeScript types (it's okay to leave the rest blank in this case)
  • Code changes

How did you verify your code works?

null

@paperclover
Copy link
Member

im not 100% sure about this because while clonefile files do not take more space on the disk, they do contribute to the total disk space used (as in, the file is counted twice)

@paperclover
Copy link
Member

i think instead of talking about HFS (filesystem that most do not use anymore, and im unsure if Bun even works on these older mac os systems), we should say that clonefile is copy-on-write, meaning it will not ocupy disk space, but it will count towards your drive's limit.

we can also say the copy-on-write behavior is useful because if something attempts to patch node_modules/*, it is impossible to affect other installations. but this is less important than clarifying the disk space issue.

@ImBIOS
Copy link
Contributor Author

ImBIOS commented Dec 1, 2023

@paperdave updated and ready to review again.

@Electroid Electroid requested a review from colinhacks December 5, 2023 21:09
@colinhacks colinhacks merged commit f303bcd into oven-sh:main Dec 5, 2023
@ImBIOS ImBIOS deleted the patch-9 branch December 6, 2023 16:29
ryoppippi pushed a commit to ryoppippi/bun that referenced this pull request Feb 1, 2024
* docs: update misleading `clonefile` information

* Fix macOS exception in cache module
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants