Eden

EdenSCM is a sinful-platform, extremely scalable supply alter management blueprint.

It objectives to produce both particular person-superior and critical interfaces for customers, as
smartly as low scalability to accommodate repositories containing many hundreds and hundreds
of recordsdata and plenty hundreds and hundreds of commits.

EdenSCM is made from three predominant parts:

• The eden CLI: The client-aspect uncover line interface for customers to win interplay
  with EdenSCM.
• Mononoke: The server-aspect share of EdenSCM.
• EdenFS: A virtual filesystem for efficiently attempting out beneficial repositories.

EdenSCM’s scalability dreams are to be sure that that that every supply alter operations
scale with the preference of recordsdata in direct by a developer, and no longer with the dimensions of
the repository itself. This allows mercurial, performant developer experiences
even in extensive repositories with many long recordsdata and very long commit
histories.

The eden CLI was once before every little thing constant with
Quickly, and shares many aspects of the UI
and aspects of Quickly.

The CLI code will also be present within the eden/scm subdirectory.

Building the eden CLI

The eden CLI currently builds and runs on Linux, Mac, and Home windows. The
setup.py script is the valuable interface for building the CLI, nonetheless to prepare
and install the general dependencies its suggested to birth out with a getdeps.py build
as per the Accomplish Notes

Mononoke is the server-aspect part of EdenSCM.

Regardless of getting before every little thing developed from Quickly, EdenSCM is no longer a allotted
supply alter blueprint. In account for to strengthen extensive repositories, no longer all
repository data is downloaded to the client blueprint when attempting out a
repository. Clients ideally most fascinating download the minimal quantity of data
valuable, and then get extra data from the server because it’s a ways valuable.

Building Mononoke

The Mononoke code lives below eden/mononoke

Mononoke is built the direct of Rust’s cargo build blueprint nonetheless to prepare and install the general dependencies
its suggested to birth out with a getdeps.py build as per the Accomplish Notes

EdenFS is a virtual file blueprint for managing EdenSCM checkouts.

EdenFS quickens operations in beneficial repositories by most fascinating populating working
listing recordsdata on ask, as they’re accessed. This makes operations like
checkout worthy sooner, in alternate for a puny efficiency hit when first
having access to new recordsdata. Right here’s fairly indispensable in beneficial repositories where
builders on the total most fascinating work with a puny subset of the repository at a time.

EdenFS has the same efficiency advantages to the direct of sparse checkouts, but a worthy
better particular person trip. Not like with sparse checkouts, EdenFS does no longer require
manually curating the listing of recordsdata to establish out, and customers can transparently
receive entry to any file with out desiring to update the profile.

EdenFS also retains music of which recordsdata win been modified, allowing very
efficient reputation queries that attain no longer must scan the working listing.
The filesystem monitoring tool Watchman
also integrates with EdenFS, allowing it to extra efficiently music updates to
the filesystem.

Extra detailed EdenFS produce documentation will also be found at
eden/fs/docs/Overview.md.

Building EdenFS

EdenFS currently builds on Linux, Mac, and Home windows.

Eden is built the direct of a mixture of cmake and cargo with cmake as the
predominant entry point, nonetheless to prepare and install the general dependencies
its suggested to birth out with a getdeps.py build as per the Accomplish Notes

This build script will accomplish an output listing outside of the repository
where this would possibly well produce the build. You may well well alter this output listing
space by passing a --scratch-direction argument to the build script.

On Ubuntu, both let getdeps install the requirements or read requirements_ubuntu.txt.
You too can need m4 and Rust set in.

EdenSCM is the valuable supply alter blueprint frail at Facebook, and is frail for
Facebook’s predominant monorepo code immoral.

Support for the direct of EdenSCM outside of Facebook is accumulated extremely experimental.
While we would win an interest to hear solutions if you speed into points,
supporting exterior customers is no longer currently a excessive precedence for the kind
team, so we unfortunately can no longer guarantee instructed strengthen at the moment.

Gaze LICENSE.

getdeps.py

This script is frail by many of Meta’s OSS tools. It would download and build all of the mandatory dependencies first, and can accumulated then invoke cmake etc to build the Eden parts. This can even assist be sure that that that you just build with relevant versions of all of the dependent libraries, taking under consideration what versions are set in locally for your blueprint.

Or no longer it’s written in python so that you just are going to need python3.6 or later for your PATH. It works on Linux, macOS and Home windows.

The settings for eden’s cmake builds are held in its getdeps manifests: Eden CLI: build/fbcode_builder/manifests/eden_scm, EdenFS: build/fbcode_builder/manifests/eden, and Mononoke: build/fbcode_builder/manifests/mononoke which you may well presumably edit locally if desired. Most getdeps instructions exhaust the manifest name as a paramenter (example below).

Dependencies

If on Linux or MacOS (with homebrew set in) you may well presumably install blueprint dependencies to build building them:

# Clone the repo
git clone https://github.com/facebookexperimental/eden
# Install dependencies
cd eden
sudo ./build/fbcode_builder/getdeps.py install-blueprint-deps --recursive [eden_scm|eden|mononoke]

Ought to you need to sight the programs sooner than installing them:

./build/fbcode_builder/getdeps.py install-blueprint-deps --dry-speed --recursive [eden_scm|eden|mononoke]

On different platforms or if on Linux and with out blueprint dependencies getdeps.py will principally download and build them for you correct thru the build step.

NB: getdeps.py also can no longer install the C++ toolchain or Rust toolchain for you.

Accomplish

This script will download and build all of the mandatory dependencies first,
and can accumulated then invoke cmake and cargo etc to build the parts of EdenSCM.
This can even assist be sure that that that you just build with relevant versions of all of the dependent libraries,
taking under consideration what versions are set in locally for your blueprint.

getdeps.py currently requires python 3.6+ to be for your direction.

getdeps.py will invoke cmake and cargo etc for a manifest (here viewed for eden_scm)

# Clone the repo
git clone https://github.com/facebookexperimental/eden
cd eden
# Accomplish, the direct of blueprint dependencies if on hand
python3 ./build/fbcode_builder/getdeps.py --allow-blueprint-programs build eden_scm

Specify eden_scm for Eden CLI, eden for EdenFS, or mononoke for Mononoke build.

It puts output in its scratch location. You may well even get the default scratch install space from logs or with python3 ./build/fbcode_builder/getdeps.py point out-inst-dir eden_scm

You may well even also specify a --scratch-direction argument to alter
the placement of the scratch listing frail for the build.

There are also
--install-dir and --install-prefix arguments to produce some extra
stunning-grained alter of the installation directories. Nonetheless, provided that
EdenSCM affords no compatibility guarantees between commits we most regularly
imply building and installing to a non eternal space, in desire to
installing to the old faculty blueprint installation directories.

Ought to you like to must invoke cmake again to iterate on EdenFS, there’s a priceless run_cmake.py script output within the scratch build listing. You may well even get the scratch build listing from logs or with python3 ./build/fbcode_builder/getdeps.py point out-build-dir eden

Bolt assessments

By default getdeps.py will build the assessments for a manifest eden_scm. To speed them:

cd eden
python3 ./build/fbcode_builder/getdeps.py --allow-blueprint-programs take a look at eden_scm

Accomplish with cmake straight

Ought to you do no longer must let getdeps invoke cmake for then you definately by default, building the assessments is disabled as share of the CMake all target.
To construct the assessments, specify -DBUILD_TESTS=ON to CMake at configure time.

NB if you like to must invoke cmake again to iterate on a getdeps.py build, there’s a priceless run_cmake.py script output within the scratch-direction build listing. You may well even get the scratch build listing from logs or with python3 ./build/fbcode_builder/getdeps.py point out-build-dir

Running assessments with ctests also works if you cd to the build dir, e.g. (cd $(python3 ./build/fbcode_builder/getdeps.py point out-build-dir) && ctest)`

Ubuntu LTS, CentOS Circulation, Fedora

Use the getdeps.py scheme above. We take a look at in CI on Ubuntu LTS, and occasionally on different distros.

Ought to you get the placement of blueprint programs is no longer fairly accurate for your chosen distro, you may well presumably specify distro version particular overrides within the dependency manifests (e.g. build/fbcode_builder/manifests/enhance ). You may well even potentially maintain it work on most most as much as the moment Ubuntu/Debian or Fedora/Redhat derived distributions.

At time of writing (Feb 2022) there’s a build destroy on GCC 11.x primarily based entirely entirely systems in folly which in turn will destroy fbthrift and thus Eden. The utilization of Ubuntu 20.04 in a virtual atmosphere is one possible workaround for this to exhaust a sight at out the Eden tools.

Home windows

Eden CLI, EdenFS are frail on Home windows. getdeps.py regularly is the capacity to birth with EdenFS having the elevated likelihood of success, nonetheless we don’t speed these in github CI

Mononoke is no longer supported on Home windows.

macOS

getdeps.py builds work on macOS and are tested in CI, nonetheless if you opt, you may well presumably are attempting one of many macOS equipment managers