be1fc528af
…rmation <!-- Please describe your changes on the following line: --> this is a new file which doesn't affect anything in servo, instead this is used for when servo is vendored into mozilla-central to build Firefox we expect all files in the tree to have a mapping to a bugzilla component. --- <!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: --> - [X] `./mach build -d` does not report any errors - NOTE: I pushed to try to get this, running locally was taking a long time - [X] `./mach test-tidy` does not report any errors - [X] These changes fix https://bugzilla.mozilla.org/show_bug.cgi?id=1411583 <!-- Either: --> - [X] These changes do not require tests because this is a meta data file for when this code is added to mozilla-central <!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.--> <!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. --> Source-Repo: https://github.com/servo/servo Source-Revision: 98a90d25cf67ce6ed446f40e4efe84e18440cea1 --HG-- extra : subtree_source : https%3A//hg.mozilla.org/projects/converted-servo-linear extra : subtree_revision : ef7c648aa44902b141425da3a218fce5f93fc240 |
||
---|---|---|
.. | ||
components | ||
docs | ||
etc | ||
ports | ||
python | ||
resources | ||
support | ||
tests | ||
.gitattributes | ||
.gitignore | ||
.hgignore | ||
.mailmap | ||
.travis.yml | ||
appveyor.yml | ||
Cargo.lock | ||
Cargo.toml | ||
CLOBBER | ||
CONTRIBUTING.md | ||
dependencyci.yml | ||
Info.plist | ||
LICENSE | ||
mach | ||
mach.bat | ||
moz.build | ||
PULL_REQUEST_TEMPLATE.md | ||
README.md | ||
rust-stable-version | ||
rust-toolchain | ||
rustfmt.toml | ||
servo-tidy.toml | ||
servobuild.example |
The Servo Parallel Browser Engine Project
Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64bit OS X, 64bit Linux, 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.
Setting up your environment
Please select your operating system:
OS X
On OS X (homebrew)
brew install automake pkg-config python cmake yasm
pip install virtualenv
On OS X (MacPorts)
sudo port install python27 py27-virtualenv cmake yasm
On OS X >= 10.11 (El Capitan), you also have to install OpenSSL
brew install openssl
export OPENSSL_INCLUDE_DIR="$(brew --prefix openssl)/include"
export OPENSSL_LIB_DIR="$(brew --prefix openssl)/lib"
./mach build ...
If you've already partially compiled servo but forgot to do this step, run ./mach clean
, set the shell variables, and recompile.
On Debian-based Linuxes
sudo apt install git curl freeglut3-dev autoconf libx11-dev \
libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
gperf g++ build-essential cmake virtualenv python-pip \
libssl1.0-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \
libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdbus-1-dev
If you using a version prior to Ubuntu 17.04 or Debian Sid, replace libssl1.0-dev
with libssl-dev
.
If you are on Ubuntu 14.04 and encountered errors on installing these dependencies involving libcheese
, see #6158 for a workaround.
If virtualenv
does not exist, try python-virtualenv
.
On Fedora
sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \
freetype-devel mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel gperf \
fontconfig-devel cabextract ttmkfdir python python-virtualenv python-pip expat-devel \
rpm-build openssl-devel cmake bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \
dbus-devel ncurses-devel
On openSUSE Linux
sudo zypper install libX11-devel libexpat-devel libbz2-devel Mesa-libEGL-devel Mesa-libGL-devel cabextract cmake \
dbus-1-devel fontconfig-devel freetype-devel gcc-c++ git glib2-devel gperf \
harfbuzz-devel libOSMesa-devel libXcursor-devel libXi-devel libXmu-devel libXrandr-devel libopenssl-devel \
python-pip python-virtualenv rpm-build glu-devel
On Arch Linux
sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu pkg-config
On Gentoo Linux
sudo emerge net-misc/curl media-libs/freeglut \
media-libs/freetype media-libs/mesa dev-util/gperf \
dev-python/virtualenv dev-python/pip dev-libs/openssl \
x11-libs/libXmu media-libs/glu x11-base/xorg-server
On Windows (MSVC)
-
Install Python for Windows (https://www.python.org/downloads/release/python-2714/). The Windows x86-64 MSI installer is fine. You should change the installation to install the "Add python.exe to Path" feature.
-
Install virtualenv.
In a normal Windows Shell (cmd.exe or "Command Prompt" from the start menu), do:
pip install virtualenv
If this does not work, you may need to reboot for the changed PATH settings (by the python installer) to take effect.
-
Install Git for Windows (https://git-scm.com/download/win). DO allow it to add git.exe to the PATH (default settings for the installer are fine).
-
Install Visual Studio Community 2017 (https://www.visualstudio.com/vs/community/). You MUST add "Visual C++" to the list of installed components. It is not on by default. Visual Studio 2017 MUST installed to the default location or mach.bat will not find it.
If you encountered errors with the environment above, do the following for a workaround:
- Download and install Build Tools for Visual Studio 2017
- Install
python2.7 x86-x64
andvirtualenv
- Run
mach.bat build -d
.
If you have troubles with
x64 type
prompt asmach.bat
set by default:
- you may need to choose and launch the type manually, such as
x86_x64 Cross Tools Command Prompt for VS 2017
in the Windows menu.)cd to/the/path/servo
python mach build -d
Cross-compilation for Android
Pre-installed Android tools are needed. See wiki for details
The Rust compiler
Servo's build system automatically downloads a Rust compiler to build itself.
This is normally a specific revision of Rust upstream, but sometimes has a
backported patch or two.
If you'd like to know which nightly build of Rust we use, see
rust-toolchain
.
Building
Servo is built with Cargo, the Rust package manager. We also use Mozilla's Mach tools to orchestrate the build and other tasks.
Normal build
To build Servo in development mode. This is useful for development, but the resulting binary is very slow.
git clone https://github.com/servo/servo
cd servo
./mach build --dev
./mach run tests/html/about-mozilla.html
Or on Windows MSVC, in a normal Command Prompt (cmd.exe):
git clone https://github.com/servo/servo
cd servo
mach.bat build --dev
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
git clone https://github.com/servo/servo
cd servo
export ANDROID_SDK="/path/to/sdk"
export ANDROID_NDK="/path/to/ndk"
export ANDROID_TOOLCHAIN="/path/to/toolchain"
export PATH="$PATH:/path/to/toolchain/bin"
./mach build --release --android
./mach package --release --android
Rather than setting the ANDROID_*
environment variables every time, you can
also create a .servobuild
file and then edit it to contain the correct paths
to the Android SDK/NDK tools:
cp servobuild.example .servobuild
# edit .servobuild
Running
Use ./mach run [url]
to run Servo. Like so,
./mach run https://www.google.com
Also, don't miss the info on the browserhtml page on how to run the Browser.html full tech demo (it provides a more browser-like experience than just browsing a single URL with servo).
Commandline Arguments
-p INTERVAL
turns on the profiler and dumps info to the console everyINTERVAL
seconds-s SIZE
sets the tile size for painting; defaults to 512-z
disables all graphical output; useful for running JS / layout tests-Z help
displays useful output to debug servo
Keyboard Shortcuts
Ctrl
+-
zooms outCtrl
+=
zooms inAlt
+left arrow
goes backwards in the historyAlt
+right arrow
goes forwards in the historyEsc
exits servo
Developing
There are lots of mach commands you can use. You can list them with ./mach --help
.
The generated documentation can be found on http://doc.servo.org/servo/index.html