facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-09-11 10:36:52 +03:00
Code Issues Projects Releases Wiki Activity
A Scalable, User-Friendly Source Control System.
90,807 Commits 23 Branches 62 Tags 322 MiB
Rust 45.1%
Python 20.8%
C++ 10.5%
Perl 9%
TypeScript 7.3%
Other 7.1%
e3d237a591
Go to file
lamasters e3d237a591 Add Linux Mint to getdeps Debian package manager options 
Summary:
X-link: https://github.com/facebookincubator/zstrong/pull/909

Linux Mint is based on Ubuntu and installs correctly with the same options. This adds it to the supported versions so that running `sudo ./install-system-packages.sh` succeeds.

X-link: https://github.com/facebook/watchman/pull/1234

Reviewed By: chadaustin

Differential Revision: D59666084

Pulled By: genevievehelsel

fbshipit-source-id: cfdee239be6358d4c8e2f1154391159a40ef91f4
2024-07-13 13:50:32 -07:00
.devcontainer Add a devcontainer config (#807) 2024-01-18 08:29:13 -08:00
.github/workflows bump repo ci to ubuntu-22.04 2024-05-07 09:51:01 -07:00
addons Migrate Kbd to isl-components/ 2024-07-12 16:42:23 -07:00
build Add Linux Mint to getdeps Debian package manager options 2024-07-13 13:50:32 -07: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 Prefer module filenames instead of mod.rs 2024-04-09 10:26:48 -07:00
configerator/structs/scm derived_data_service: use config to disallow deriving some types for ephemeral bubbles 2024-07-09 09:07:21 -07:00
eden Update to advice problems in check_recent_writes 2024-07-12 17:19:05 -07:00
fb303/thrift Add package keyword 2024-06-24 09:47:15 -07:00
thrift/annotation Make the scope for @thrift.AllowReservedIdentifierName more robust. 2024-07-09 10:57:09 -07:00
website Update internal-difference-hg.md (#919) 2024-07-11 11:16:22 -07: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.