gecko-dev/servo
r3c0d3x 4609f2c8a8 servo: Merge #15511 - Fix fmt::Display vs fmt::Debug URL (from r3c0d3x:patch-1); r=Wafflespeanut
<!-- Please describe your changes on the following line: -->
Fixed a Rust documentation link in [`HACKING_QUICKSTART.md`](44e808b5cf/docs/HACKING_QUICKSTART.md)
---
The link to Rust's documentation comparing `fmt::Display` and `fmt::Debug` no longer points to the right section of the page.

- [x] These changes do not require tests because it's simply changing a URL in the documentation.

<!-- 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: eca8c4ed7384e98efcb15b8ef603f27650126fd5

--HG--
extra : subtree_source : https%3A//hg.mozilla.org/projects/converted-servo-linear
extra : subtree_revision : 9451958c39f58bfc06666554d45dda1fa6b7d381
2017-02-11 09:36:43 -08:00
..
components servo: Merge #15427 - Remove slice_to_array_buffer_view and update_array_buffer_view (from deror1869107:rewrite-webvr); r=jdm 2017-02-11 08:04:15 -08: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 #15067 - Added async performance test (from shinglyu:stylo-perf-async); r=Manishearth 2017-02-07 18:59:03 -08:00
ports servo: Merge #15509 - stylo: Remove useless traverse_subtree call warning (from heycam:rm-warning); r=emilio 2017-02-11 01:55:15 -08:00
python servo: Merge #14853 - Make tidy work on stylo trees (from Manishearth:stylo-tidy); r=Wafflespeanut 2017-02-08 22:21:08 -08:00
resources servo: Merge #15104 - added lets encrypt authority x3 to trusted roots pem (from avadacatavra:letsencryptauth); r=SimonSapin 2017-01-19 12:03:26 -08:00
support servo: Merge #15396 - android: extract resources to external storage on first launch (from zhuowei:android-extract-resources); r=larsbergstrom 2017-02-09 12:27:12 -08:00
tests servo: Merge #15454 - use `::parse_non_negative instead` of `::parse` for background_size property parsing (from jlevesy:bg-size-reject-negative-values); r=SimonSapin 2017-02-09 14:55:14 -08:00
.gitattributes servo: Merge #6336 - Appease Github's Linguist (from nerith:master); r=Manishearth 2015-06-10 22:30:58 -06:00
.gitignore servo: Merge #14551 - Remove legacy items from .gitignore (from upsuper:legacy-gitignore); r=emilio 2016-12-12 02:01:42 -08: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 #15393 - Windows: Instructions update, removed freetype and silent some warning (from UK992:win32); r=metajack 2017-02-05 17:33:23 -08:00
CONTRIBUTING.md servo: Merge #10687 - Encourage better documentation patterns (from jdm:docs); r=larsbergstrom 2016-04-19 05:44:00 +05:01
Cargo.lock servo: Merge #15352 - Rewrite WebGLRenderingContext to use typed array APIs (from jdm:Rewrite-WebGLRenderingContext-to-use-typed-array-APIs); r=jdm 2017-02-10 13:57:35 -08:00
Cargo.toml servo: Merge #14995 - Enable codegen-units=4 in debug mode (from servo:codegen-units); r=mbrubeck 2017-01-15 13:23:55 -08: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
PULL_REQUEST_TEMPLATE.md servo: Merge #12772 - Avoid a common formatting problem in pull requests (from servo:jdm-patch-2); r=Manishearth 2016-08-08 12:12:39 -05:00
README.md servo: Merge #15393 - Windows: Instructions update, removed freetype and silent some warning (from UK992:win32); r=metajack 2017-02-05 17:33:23 -08:00
appveyor.yml servo: Merge #15393 - Windows: Instructions update, removed freetype and silent some warning (from UK992:win32); r=metajack 2017-02-05 17:33:23 -08:00
cargo-commit-hash servo: Merge #15277 - Update to cargo 0.17.0-nightly (385e243 2017-01-27) (from servo:cargoup); r=emilio 2017-01-28 23:05:15 -08:00
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
mach servo: Merge #14039 - Fix test-wpt and test-css for Windows (from metajack:windows-wpt); r=jgraham 2016-11-16 13:41:27 -06:00
mach.bat servo: Merge #15319 - Fix hardcoded path to link.exe (from UK992:win32); r=emilio,larsbergstrom 2017-02-03 09:59:11 -08:00
rust-nightly-date servo: Merge #15351 - Upgrade to rustc 1.17.0-nightly (ea7a6486a 2017-02-04) (from servo:rustup); r=nox 2017-02-05 07:01:32 -08:00
rust-stable-version servo: Merge #14789 - Support @supports (from Manishearth:supports); r=SimonSapin 2017-01-09 10:54:38 -08: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 #15447 - Move rust-selectors into servo/servo (from bholley:in_tree_selectors); r=SimonSapin 2017-02-08 16:06:06 -08:00
servobuild.example servo: Merge #15390 - Option configuration to enable incremental compilation (from servo:opt-in-incremental); r=nox 2017-02-05 06:07:13 -08:00

README.md

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

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 & MinGW)

  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. (MSVC only) 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. (MSVC only) 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.

  3. (MinGW only) Install MSYS2 (https://msys2.github.io/). After you have done so, open an MSYS shell window and update the core libraries and install new packages. The extra step at the end is to downgrade GCC to 5.4, as the GCC6 versions in mingw currently fail to compile some of our dependencies. We are upgrading to a gcc-free build on Windows as soon as possible:

pacman -Su
pacman -Sy git mingw-w64-x86_64-toolchain mingw-w64-x86_64-icu \
   mingw-w64-x86_64-nspr mingw-w64-x86_64-ca-certificates \
   mingw-w64-x86_64-expat mingw-w64-x86_64-cmake tar diffutils patch \
   patchutils make python2-setuptools
export GCC_URL=http://repo.msys2.org/mingw/x86_64/mingw-w64-x86_64-gcc
export GCC_EXT=5.4.0-1-any.pkg.tar.xz
pacman -U --noconfirm $GCC_URL-$GCC_EXT $GCC_URL-ada-$GCC_EXT \
   $GCC_URL-fortran-$GCC_EXT $GCC_URL-libgfortran-$GCC_EXT $GCC_URL-libs-$GCC_EXT \
   $GCC_URL-objc-$GCC_EXT

Add the following line to the end of .profile in your home directory:

export PATH=/c/Python27:/c/Python27/Scripts:$PATH

Now, open a MINGW64 (not MSYS!) shell window, and you should be able to build servo as usual!

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-nightly-date.

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