facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-07 15:27:13 +03:00
Code Issues Projects Releases Wiki Activity
A Scalable, User-Friendly Source Control System.
79,877 Commits 24 Branches 62 Tags 320 MiB
Rust 45.1%
Python 20.7%
C++ 10.5%
Perl 9.1%
TypeScript 7.3%
Other 7.1%
27be1a7b80
Go to file
Open Source Bot 27be1a7b80 Updating submodules 
Summary:
GitHub commits:

64656d4ff0
1adec95167
01376bc68e
1ff61164b4
0ec6d43775
2551dd0362
77a9b2048b
54a9d7145d
19617b9525

Reviewed By: jurajh-fb

fbshipit-source-id: 3f7dd2352655f676d4ad0a09c19b33fad55283e0
2023-01-18 12:58:10 -08:00
.github/workflows bump Python in Github macOS actions to 3.11 (#319) 2022-12-12 12:52:55 -08:00
addons Add context menu 2023-01-13 09:14:31 -08:00
build Updating submodules 2023-01-18 12:58:10 -08:00
ci further improve compatibility with Homebrew 2022-12-13 11:54:51 -08:00
CMake cmake-rust: merge two RustStaticLibrary.cmake and add feature support 2022-09-13 16:18:27 -07:00
common Use cached values 2022-08-10 11:06:01 -07:00
configerator/structs/scm (2/2) Rename write mostly to write only 2023-01-13 09:23:35 -08:00
eden commit_graph: construct cache for commit graph 2023-01-18 09:43:07 -08:00
website website: arch linux installation instructions (#473) 2023-01-18 10:31:36 -08:00
.gitignore mononoke: add README.md and the missing pieces for supporting cargo (#13) 2020-02-13 00:12:36 -08:00
.projectid replace the old getdeps.py script with a build.sh script 2020-03-30 19:27:54 -07:00
build.bat fs: fix license header 2022-01-04 15:00:07 -08:00
build.sh fs: fix license header 2022-01-04 15:00:07 -08:00
CMakeLists.txt fs: fix license header 2022-01-04 15:00:07 -08:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:23:31 -07:00
CONTRIBUTING.md Replace mentions of Eden with Sapling (#162) 2022-11-16 17:55:02 -08:00
LICENSE relicense to GPLv2 2019-06-19 17:02:45 -07:00
make-client.py fs: fix license header 2022-01-04 15:00:07 -08:00
README.md website: downplay Mononoke and EdenFS in readme.md 2022-11-15 09:02:28 -08:00
requirements_ubuntu.txt include oss installation instructions for ubuntu 2020-07-24 11:34:17 -07:00
rustfmt.toml rustfmt.toml: group_imports = StdExternalCrate 2022-08-06 12:33:42 -07:00
SAPLING_VERSION bump SAPLING_VERSION from 0.1 to 0.2 in preparation for the next release 2022-12-21 12:23:53 -08:00

README.md

Sapling SCM

Sapling SCM is a cross-platform, highly scalable, Git-compatible source control system.

It aims to provide both user-friendly and powerful interfaces for users, as well as extreme scalability to deal with repositories containing many millions of files and many millions of commits.

Using Sapling

To start using Sapling, see the Getting Started page for how to clone your existing Git repositories. Checkout the Overview for a peek at the various features. Coming from Git? Checkout the Git Cheat Sheet.

Sapling also comes with an Interactive Smartlog (ISL) web UI for seeing and interacting with your repository, as well as a VS Code integrated Interactive Smartlog.

The Sapling Ecosystem

Sapling SCM is comprised of three main components:

  • The Sapling client: The client-side sl command line and web interface for users to interact with Sapling SCM.
  • Mononoke: A highly scalable distributed source control server. (Not yet supported publicly.)
  • EdenFS: A virtual filesystem for efficiently checking out large repositories. (Not yet supported publicly.)

Sapling SCM's scalability goals are to ensure that all source control operations scale with the number of files in use by a developer, and not with the size of the repository itself. This enables fast, performant developer experiences even in massive repositories with millions of files and extremely long commit histories.

Sapling CLI

The Sapling CLI, sl, was originally based on Mercurial, and shares various aspects of the UI and features of Mercurial.

The CLI code can be found in the eden/scm subdirectory.

Mononoke

Mononoke is the server-side component of Sapling SCM.

While it is used in production within Meta, it currently does not build in an open source context and is not yet supported for external usage.

EdenFS

EdenFS is a virtual file system for managing Sapling checkouts.

While it is used in production within Meta, it currently does not build in an open source context and is not yet supported for external usage.

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.

More detailed EdenFS design documentation can be found at eden/fs/docs/Overview.md.

Building the Sapling CLI

The Sapling CLI currently builds and runs on Linux, Mac, and Windows. It can be built by running make oss in the eden/scm directory and running the resulting sl executable.

Building the Sapling CLI requires Python 3.8, Rust, cmake, and OpenSSL for the main cli, and Node and Yarn for the ISL web UI.

License

See LICENSE.