f4d3af296c
This is the start of the organization of types that are in their own crates in order to break dependency cycles between other crates. The idea here is that putting these packages into their own directory is the first step toward cleaning them up. They have grown organically and it is difficult to explain to new folks where to put new shared types. Many of these crates contain more than traits or don't contain traits at all. Notably, `script_traits` isn't touched because it is vendored from Gecko. Eventually this will move to `third_party`. |
||
|---|---|---|
| .cargo | ||
| .github | ||
| .vscode | ||
| components | ||
| docs | ||
| etc | ||
| ports | ||
| python | ||
| resources | ||
| support | ||
| tests | ||
| third_party | ||
| .clang-format | ||
| .flake8 | ||
| .gitattributes | ||
| .gitignore | ||
| .hgignore | ||
| .mailmap | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CLOBBER | ||
| CONTRIBUTING.md | ||
| dependencyci.yml | ||
| Info.plist | ||
| LICENSE | ||
| mach | ||
| mach.bat | ||
| PULL_REQUEST_TEMPLATE.md | ||
| README.md | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
| servo-tidy.toml | ||
| servobuild.example | ||
| taplo.toml | ||
The Servo Parallel Browser Engine Project
Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64-bit macOS, 64-bit Linux, 64-bit Windows, and Android.
Servo welcomes contribution from everyone. See
CONTRIBUTING.md and HACKING_QUICKSTART.md
for help getting started.
Visit the Servo Project page for news and guides.
Build Setup
If these instructions fail or you would like to install dependencies manually, try the manual build setup.
macOS
- Install Xcode
- Install Homebrew
- Run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - Run
pip3 install virtualenv - Run
./mach bootstrap
Note: This will install the recommended version of GStreamer globally on your system.
Linux
- Run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - Install Python and virtualenv
- Debian-like: Run
sudo apt install python3-virtualenv python3-pip - Fedora: Run
sudo dnf install python3 python3-virtualenv python3-pip python3-devel - Arch: Run
sudo pacman -S --needed python python-virtualenv python-pip - Gentoo: Run
sudo emerge dev-python/virtualenv dev-python/pip
- Debian-like: Run
- Run
./mach bootstrap
Windows
- Download and run
rustup-init.exethen follow the onscreen instructions. - Install chocolatey
- Run
mach bootstrap - This will install CMake, Git, Ninja, Python and the Visual Studio 2019 Build Tools via choco in an Administrator console. It can take quite a while.
- If you already have Visual Studio 2019 installed, this may not install all necessary components. Please follow the Visual Studio 2019 installation instructions in the manual setup.
- Run
refreshenv
See also Windows Troubleshooting Tips.
Cloning the Repo
Your CARGO_HOME needs to point to (or be in) the same drive as your Servo repository (See #28530).
git clone https://github.com/servo/servo
cd servo
Building
Servo is built with Cargo, the Rust package manager. We also use Mozilla's Mach tools to orchestrate the build and other tasks. You can call Mach like this:
On Unix systems:
./mach [command] [arguments]
On Windows Commandline:
mach.bat [command] [arguments]
The examples below will use Unix, but the same applies to Windows.
The Rust compiler
Servo's build system uses rustup.rs to automatically download a Rust compiler.
This is a specific version of Rust Nightly determined by the
rust-toolchain file.
Normal build
To build Servo in development mode. This is useful for development, but the resulting binary is very slow:
./mach build --dev
./mach run tests/html/about-mozilla.html
Release build
For benchmarking, performance testing, or real-world use.
Add the --release flag to create an optimized build:
./mach build --release
./mach run --release tests/html/about-mozilla.html
Checking for build errors, without building
If you’re making changes to one crate that cause build errors in another crate, consider this instead of a full build:
./mach check
It will run cargo check, which runs the analysis phase of the compiler
(and so shows build errors if any) but skips the code generation phase.
This can be a lot faster than a full build,
though of course it doesn’t produce a binary you can run.
Building for Android target
For ARM (armv7-linux-androideabi, most phones):
./mach build --release --android
./mach package --release --android
For x86 (typically for the emulator):
./mach build --release --target i686-linux-android
./mach package --release --target i686-linux-android
Running
Run Servo with the command:
./servo [url] [arguments] # if you run with nightly build
./mach run [url] [arguments] # if you run with mach
# For example
./mach run https://www.google.com
Commandline Arguments
-p INTERVALturns on the profiler and dumps info to the console everyINTERVALseconds-s SIZEsets the tile size for painting; defaults to 512-zdisables all graphical output; useful for running JS / layout tests-Z helpdisplays useful output to debug servo
Keyboard Shortcuts
Ctrl+Lopens URL prompt (Cmd+Lon Mac)Ctrl+Rreloads current page (Cmd+Ron Mac)Ctrl+-zooms out (Cmd+-on Mac)Ctrl+=zooms in (Cmd+=on Mac)Alt+left arrowgoes backwards in the history (Cmd+left arrowon Mac)Alt+right arrowgoes forwards in the history (Cmd+right arrowon Mac)EscorCtrl+Qexits Servo (Cmd+Qon Mac)
Runtime dependencies
Linux
GStreamer>=1.16gst-plugins-bad>=1.16libXcursorlibXrandrlibXilibxkbcommonvulkan-loader
Developing
There are lots of mach commands you can use. You can list them with ./mach --help.
The generated documentation can be found on https://doc.servo.org/servo/index.html