1a0d7106a4
Summary: Add a devcontainer config My laptop is full of weird versions of weird tools. Sapling requires specific versions of specific tools. It's nice to be able to open the sapling folder in vscode and get a prompt for "would you like to do your development inside a container with all the correct tools pre-installed?" :) This also allows people on github to click a button to open in github's web-based container-IDE and start developing without installing anything at all, though I don't know if we'd expect anybody to do that For starters I'm using the CI build image without changes to try and keep the maintenance burden as small as possible, though it would be possible to use a separate layer within the Dockerfile (eg if we wanted to install extra tools that are useful for dev but not needed for building), or have a totally separate Dockerfile --- [//]: # (BEGIN SAPLING FOOTER) Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/facebook/sapling/pull/807). * __->__ https://github.com/facebook/sapling/issues/807 * https://github.com/facebook/sapling/issues/806 * https://github.com/facebook/sapling/issues/804 Pull Request resolved: https://github.com/facebook/sapling/pull/807 Differential Revision: D52575911 Pulled By: quark-zju fbshipit-source-id: b24e1a21493f18a06355c984a72936cd11fef2ea |
||
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| addons | ||
| build | ||
| ci | ||
| CMake | ||
| common | ||
| configerator/structs/scm | ||
| eden | ||
| website | ||
| .gitignore | ||
| .projectid | ||
| build.bat | ||
| build.sh | ||
| clippy.toml | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| make-client.py | ||
| README.md | ||
| requirements_ubuntu.txt | ||
| rustfmt.toml | ||
| SAPLING_VERSION | ||
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
slcommand 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.