cd5b4b6d92
Summary: This diff enables building the eden watcher by linking in thrift and its various dependencies. To support building in-fbsource and in the github repo, a `maybe_shipit_dir` function is used to setup a symlink to the `eden` and `fboss/common` dirs (this mirrors the shipit configuration for this project: we cannot simply run shipit because we have to build on mac and windows and shipit requires Hack, and that does not support those platforms). I tried to persuade cmake to let me build this without the use of a symlink but found it too difficult to teach everything about the path mapping. The symlinks aren't terrible, but are the reason why this diff also updates some `.gitinore` files that are seemingly unrelated to this diff. This diff changes a couple of build/link options: without them the end product fails to link either due to implicit/unilateral enablement of UBSAN in some of the deps, or because warning->error promotion is turned on. This diff includes a copy of the `ThriftCppLibrary.cmake` file from the fboss repo. This should get centralized and shipit'ed out into the places that consume it. That can be done when someone gets around to doing the same for the `FindGlog.cmake` file and doesn't need to hold up this diff. Reviewed By: simpkins Differential Revision: D13486486 fbshipit-source-id: 3bb5b011771b2a87618147ca019b4e50a8e0aaf2 |
||
|---|---|---|
| CMake | ||
| common | ||
| eden | ||
| .gitignore | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| getdeps.py | ||
| LICENSE | ||
| make-client.py | ||
| PATENTS | ||
| 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.