facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-05 06:18:07 +03:00
Code Issues Projects Releases Wiki Activity
A Scalable, User-Friendly Source Control System.
88,135 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%
092c3a47f5
Go to file
Open Source Bot 092c3a47f5 Updating submodules 
Summary:
GitHub commits:

50da3609a1
0994824480
d010d83518
080d2a3b82
5bdd3f33a9
919f98bba7
6393c2daf3
f1b340f60c
9c38fb4a58
7c733b2925
3b45d38dc1
69337e58fe
4f155be5b5
dbeed9724b
ee8b2facbc

Reviewed By: bigfootjon

fbshipit-source-id: 45f8431eb0459dc34d66fbec7c5cff918486d336
2024-03-04 09:46:12 -08:00
.devcontainer Add a devcontainer config (#807) 2024-01-18 08:29:13 -08:00
.github/workflows contrib -> eden/contrib 2024-02-15 10:17:54 -08:00
addons apply Black 2024 style in fbcode (9/16) 2024-03-02 17:31:19 -08:00
build Updating submodules 2024-03-04 09:46:12 -08:00
ci Add a devcontainer config (#807) 2024-01-18 08:29:13 -08:00
CMake add FilteredHg mixin type to EdenRepoTest 2023-12-19 22:20:08 -08:00
common Remove scm_telemetry.toml 2024-02-22 05:24:48 -08:00
configerator/structs/scm Soft deprecate client, mock, and server modules 2024-02-28 20:20:39 -08:00
eden WIP: Eden cli: log details of file handle release 2024-03-04 09:12:10 -08:00
fb303/thrift Re-sync with internal repository 2024-02-21 21:16:37 -05:00
thrift/annotation Remove @cpp.GenerateTypedInterceptor and associated codegen 2024-03-01 17:47:02 -08:00
website apply Black 2024 style in fbcode (9/16) 2024-03-02 17:31:19 -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
clippy.toml clippy: prevent holding a span guard over an .await 2023-11-16 07:31:54 -08:00
CMakeLists.txt add FilteredHg mixin type to EdenRepoTest 2023-12-19 22:20:08 -08:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:23:31 -07:00
CONTRIBUTING.md fix CONTRIBUTING.md to reference main instead of master (#436) 2023-01-18 19:58:13 -08:00
dependabot.yml oss: attempt to disable dependabot PRs 2024-02-23 12:52:06 -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 Fix spelling mistake (#677) 2023-07-25 12:33:29 -07:00
requirements_ubuntu.txt include oss installation instructions for ubuntu 2020-07-24 11:34:17 -07:00
rustfmt.toml format_code_in_doc_comments = true 2024-01-09 22:59:04 -08: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.