gecko-dev/servo
Nazım Can Altınova 025efd524f servo: Merge #16780 - Add comments to shorthand alias logic that explains the interesting bahavior (from canaltinova:shorthand-aliases); r=emilio
<!-- Please describe your changes on the following line: -->

---
<!-- 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
- [X] `./mach test-tidy` does not report any errors

<!-- Either: -->
- [X] These changes do not require tests because they are just comments and variable name change.

Source-Repo: https://github.com/servo/servo
Source-Revision: 121662aa570f9e4005deec6d502acba7ab56c076

--HG--
extra : subtree_source : https%3A//hg.mozilla.org/projects/converted-servo-linear
extra : subtree_revision : 0fa98b90dd13137836df683c20a134177ea3aaaa
2017-05-09 07:34:42 -05:00
..
components servo: Merge #16780 - Add comments to shorthand alias logic that explains the interesting bahavior (from canaltinova:shorthand-aliases); r=emilio 2017-05-09 07:34:42 -05:00
docs servo: Merge #15511 - Fix fmt::Display vs fmt::Debug URL (from r3c0d3x:patch-1); r=Wafflespeanut 2017-02-11 09:36:43 -08:00
etc servo: Merge #16303 - bump required rayon version to 0.7 (from froydnj:rayon-version-bump); r=jdm 2017-05-08 21:36:48 -05:00
ports servo: Merge #16768 - Stylo: Bug 1355408 - add support for @-moz-document (from ferjm:bug1355408.mozdocument); r=xidorn 2017-05-09 05:54:07 -05:00
python servo: Merge #16722 - Add clobber mechanism (from UK992:clobber); r=SimonSapin 2017-05-08 23:53:05 -05:00
resources servo: Merge #15773 - Android life cycle improvements and Gradle integration (from MortimerGoro:android_improvements); r=larsbergstrom,fabricedesre 2017-04-21 15:52:13 -05:00
support servo: Merge #15773 - Android life cycle improvements and Gradle integration (from MortimerGoro:android_improvements); r=larsbergstrom,fabricedesre 2017-04-21 15:52:13 -05:00
tests servo: Merge #16768 - Stylo: Bug 1355408 - add support for @-moz-document (from ferjm:bug1355408.mozdocument); r=xidorn 2017-05-09 05:54:07 -05:00
.gitattributes
.gitignore servo: Merge #15773 - Android life cycle improvements and Gradle integration (from MortimerGoro:android_improvements); r=larsbergstrom,fabricedesre 2017-04-21 15:52:13 -05:00
.hgignore servo: Merge #15376 - Add .hgignore file (from indygreg:hgignore); r=Wafflespeanut 2017-02-03 20:27:54 -08:00
.mailmap servo: Merge #14729 - Fix Clark Gaebel's entry in the mailmap (from nox:mailmap); r=emilio 2016-12-25 13:23:00 -08:00
.travis.yml servo: Merge #16767 - Try to re-enable unit tests on travis-ci (from UK992:travis); r=jdm 2017-05-08 20:05:16 -05:00
appveyor.yml servo: Merge #16490 - Remove windows gnu part 2 (from aneeshusa:remove-windows-gnu-part-2); r=metajack 2017-04-16 21:38:05 -05:00
cargo-commit-hash servo: Merge #16601 - Update to cargo 0.19.0-nightly (994e552 2017-04-25) (from servo:cargoup); r=nox 2017-04-27 23:32:54 -05:00
Cargo.lock servo: Merge #16768 - Stylo: Bug 1355408 - add support for @-moz-document (from ferjm:bug1355408.mozdocument); r=xidorn 2017-05-09 05:54:07 -05:00
Cargo.toml servo: Merge #16392 - Update the style crate's bindgen dependency to 0.24.0 (from fitzgen:update-bindgen-dependency); r=emilio 2017-05-08 12:19:59 -05:00
CLOBBER servo: Merge #16722 - Add clobber mechanism (from UK992:clobber); r=SimonSapin 2017-05-08 23:53:05 -05:00
CONTRIBUTING.md
dependencyci.yml servo: Merge #14045 - Skip dependencyci checks for known deprecated modules (from servo:jdm-patch-1); r=larsbergstrom 2016-11-04 00:40:16 -05:00
Info.plist servo: Merge #14877 - Package: Create ZIP on Windows and fix MacOS nightlies (from UK992:mach-package); r=Wafflespeanut 2017-01-05 21:45:31 -08:00
LICENSE
mach servo: Merge #16338 - Disable bytecode generation in mach (from Wafflespeanut:byte); r=jdm 2017-04-10 17:53:37 -05:00
mach.bat servo: Merge #16307 - Add support for Visual Studio 2017 (from UK992:msvc2017); r=larsbergstrom 2017-04-11 16:41:02 -05:00
PULL_REQUEST_TEMPLATE.md servo: Merge #16102 - Request users to allow edits from maintainers in PRs (from Wafflespeanut:edits); r=jdm 2017-03-23 14:32:37 -07:00
README.md servo: Merge #16490 - Remove windows gnu part 2 (from aneeshusa:remove-windows-gnu-part-2); r=metajack 2017-04-16 21:38:05 -05:00
rust-commit-hash servo: Merge #16756 - Upgrade to rustc 1.19.0-nightly (ced823e26 2017-05-07) (from servo:rustup); r=jdm 2017-05-08 16:06:56 -05:00
rust-stable-version servo: Merge #16277 - Update stable Rust version to 1.16.0 (from servo:1.16); r=Manishearth 2017-04-05 15:49:42 -05:00
rustfmt.toml servo: Merge #14831 - Rustfmt script_traits and net_traits (from servo:rustfmt-traits); r=nox 2017-01-03 08:11:09 -08:00
servo-tidy.toml servo: Merge #16303 - bump required rayon version to 0.7 (from froydnj:rayon-version-bump); r=jdm 2017-05-08 21:36:48 -05:00
servobuild.example servo: Merge #15564 - Disable LLVM assertions by default, on supported platforms (from servo:no-gods-no-masters-no-assertions); r=Ms2ger 2017-02-17 02:04:44 -08:00

The Servo Parallel Browser Engine Project

Linux Build Status Windows Build Status Changelog #228

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 \
    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)

  1. Install Python for Windows (https://www.python.org/downloads/release/python-2711/). The windows x86-64 MSI installer is fine. You should change the installation to install the "Add python.exe to Path" feature.

  2. 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.

  1. 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).

  2. Install Visual Studio 2015 Community Edition (https://www.visualstudio.com/). You MUST add "Visual C++" to the list of installed components. It is not on by default.

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-commit-hash.

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

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 every INTERVAL 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 out
  • Ctrl+= zooms in
  • Alt+left arrow goes backwards in the history
  • Alt+right arrow goes forwards in the history
  • Esc 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