mirror of https://github.com/facebook/sapling.git synced 2024-07-14 13:50:35 +03:00

A Scalable, User-Friendly Source Control System.

Go to file

Adam Simpkins 47f41ab44f relicense to GPLv2 Summary: Move away from the older BSD+PATENTS license to GPLv2. Moving to GPLv2 will make it easier for us to integrate more closely with code from Mercurial in the future, which is licensed as GPLv2+. Reviewed By: wez, strager Differential Revision: D15487085 fbshipit-source-id: efe84aa48acfcd7da3b57b5d3a78fb8d22ad6ad8		2019-06-19 17:02:45 -07:00
build	Updating submodules	2019-06-19 16:56:59 -07:00
CMake	remove ThriftCppLibrary.cmake as getdeps provides it	2019-06-17 11:10:33 -07:00
common	add a stub implementation of ServiceData::incrementCounter()	2019-06-14 18:14:43 -07:00
eden	Changing Journal API from merge to accumulateRange	2019-06-19 15:18:16 -07:00
.gitignore	eden: wire up mac contbuild	2019-02-05 21:52:30 -08:00
.travis.yml	update docker os_image to ubuntu18 and gcc7	2019-05-10 16:39:16 -07:00
CMakeLists.txt	Remove CompilerSettingsUnix from Windows builds	2019-05-31 16:16:23 -07:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT.md and reference the LICENSE file in README.md	2019-04-26 14:38:27 -07:00
CONTRIBUTING.md	relicense to GPLv2	2019-06-19 17:02:45 -07:00
getdeps.py	eden: getdeps: skip building rsocket tests	2019-02-19 14:53:22 -08:00
LICENSE	relicense to GPLv2	2019-06-19 17:02:45 -07:00
make-client.py	remove unused python imports	2019-06-12 14:00:57 -07:00
README.md	Add CODE_OF_CONDUCT.md and reference the LICENSE file in README.md	2019-04-26 14:38:27 -07:00

README.md

EdenFS is a FUSE virtual filesystem for source control repositories.

EdenFS speeds up operations in large repositories by only populating working directory files on demand, as they are accessed. This makes operations like checkout much faster, in exchange for a small performance hit when first accessing new files. This is quite beneficial in large repositories where developers often only work with a small subset of the repository at a time.

EdenFS has similar performance advantages to using sparse checkouts, but a much better user experience. Unlike with sparse checkouts, EdenFS does not require manually curating the list of files to check out, and users can transparently access any file without needing to update the profile.

EdenFS also keeps track of which files have been modified, allowing very efficient status queries that do not need to scan the working directory. The filesystem monitoring tool Watchman also integrates with EdenFS, allowing it to more efficiently track updates to the filesystem.

Building EdenFS

EdenFS currently only builds on Linux. We have primarily tested building it on Ubuntu 18.04.

TL;DR

[eden]$ ./getdeps.py --system-deps
[eden]$ mkdir _build && cd _build
[eden/_build]$ cmake ..
[eden/_build]$ make

Dependencies

EdenFS depends on several other third-party projects. Some of these are commonly available as part of most Linux distributions, while others need to be downloaded and built from GitHub.

The getdeps.py script can be used to help download and build EdenFS's dependencies.

Operating System Dependencies

Running getdeps.py with --system-deps will make it install third-party dependencies available from your operating system's package management system. Without this argument it assumes you already have correct OS dependencies installed, and it only updates and builds dependencies that must be compiled from source.

GitHub Dependencies

By default getdeps.py will check out third-party dependencies into the eden/external/ directory, then build and install them into eden/external/install/

If repositories for some of the dependencies are already present in eden/external/ getdeps.py does not automatically fetch the latest upstream changes from GitHub. You can explicitly run ./getdeps.py --update if you want it to fetch the latest updates for each dependency and rebuild them from scratch.

License

See LICENSE.