facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-05 14:28:17 +03:00
Code Issues Projects Releases Wiki Activity
A Scalable, User-Friendly Source Control System.
55,624 Commits 24 Branches 62 Tags 318 MiB
Rust 45.1%
Python 20.7%
C++ 10.5%
Perl 9.1%
TypeScript 7.3%
Other 7.1%
07dd370f28
Go to file
Lukasz Piatkowski 07dd370f28 mononoke: add README.md and the missing pieces for supporting cargo (#13) 
Summary:
Take the README.md from
7ead0e29e4/README.md
and apply it on Eden repo.

Re-add the Cargo.toml file that declares Cargo workspace.

Re-add fbcode_builder/getdeps manifest for Mononoke
Pull Request resolved: https://github.com/facebookexperimental/eden/pull/13

Test Plan:
./build/fbcode_builder/getdeps.py build mononoke
  ./build/fbcode_builder/getdeps.py test mononoke

Reviewed By: ahornby

Differential Revision: D19833059

Pulled By: lukaspiatkowski

fbshipit-source-id: fb37e13306c0b9969a7c4e52b05e1a66a577022f
2020-02-13 00:12:36 -08:00
build mononoke: add README.md and the missing pieces for supporting cargo (#13) 2020-02-13 00:12:36 -08:00
CMake eden: use third-party/rust for the vendored crates 2020-02-07 13:10:52 -08:00
common Factor our hw_port_stats_fb303 lib 2020-02-03 17:37:05 -08:00
eden mononoke: add README.md and the missing pieces for supporting cargo (#13) 2020-02-13 00:12:36 -08:00
.gitignore mononoke: add README.md and the missing pieces for supporting cargo (#13) 2020-02-13 00:12:36 -08:00
.travis.yml Re-sync with internal repository 2020-01-17 14:43:45 +01:00
CMakeLists.txt eden: add helper command for working with apfs 2020-02-03 16:59:17 -08:00
CODE_OF_CONDUCT.md mononoke: move the codebase under eden/ directory 2020-02-06 13:46:04 +01:00
CONTRIBUTING.md mononoke: move the codebase under eden/ directory 2020-02-06 13:46:04 +01:00
getdeps.py Tidy up license headers 2019-10-11 05:28:23 -07:00
LICENSE mononoke: move the codebase under eden/ directory 2020-02-06 13:46:04 +01:00
make-client.py eden: use the zipapp_main instead of main so return code gets correctly returned 2019-12-03 09:20:42 -08:00
README.md mononoke: move the codebase under eden/ directory 2020-02-06 13:46:04 +01:00
rustfmt.toml Get rustfmt/rls working in fbcode again. 2019-09-19 18:06:23 -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.