d6fbf5f1bb
- Add `--debug_libchromiumcontent` to build libchromiumcontent for debugging (shared library build). - By default, only invoke `gclient sync` the first time to checkout chromium source tree. Add `--force_update_libchromiumcontent` switch to force updating. - Document new options. The goal is to allow faster edit/compile cycles when debugging/making changes to libchromiumcontent.
221 lines
6.6 KiB
Markdown
221 lines
6.6 KiB
Markdown
# Build Instructions (Linux)
|
|
|
|
Follow the guidelines below for building Electron on Linux.
|
|
|
|
## Prerequisites
|
|
|
|
* At least 25GB disk space and 8GB RAM.
|
|
* Python 2.7.x. Some distributions like CentOS 6.x still use Python 2.6.x
|
|
so you may need to check your Python version with `python -V`.
|
|
* Node.js. There are various ways to install Node. You can download
|
|
source code from [nodejs.org](http://nodejs.org) and compile it.
|
|
Doing so permits installing Node on your own home directory as a standard user.
|
|
Or try repositories such as [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories).
|
|
* [clang](https://clang.llvm.org/get_started.html) 3.4 or later.
|
|
* Development headers of GTK+ and libnotify.
|
|
|
|
On Ubuntu, install the following libraries:
|
|
|
|
```bash
|
|
$ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \
|
|
libnotify-dev libgnome-keyring-dev libgconf2-dev \
|
|
libasound2-dev libcap-dev libcups2-dev libxtst-dev \
|
|
libxss1 libnss3-dev gcc-multilib g++-multilib curl \
|
|
gperf bison
|
|
```
|
|
|
|
On RHEL / CentOS, install the following libraries:
|
|
|
|
```bash
|
|
$ sudo yum install clang dbus-devel gtk2-devel libnotify-devel \
|
|
libgnome-keyring-devel xorg-x11-server-utils libcap-devel \
|
|
cups-devel libXtst-devel alsa-lib-devel libXrandr-devel \
|
|
GConf2-devel nss-devel
|
|
```
|
|
|
|
On Fedora, install the following libraries:
|
|
|
|
```bash
|
|
$ sudo dnf install clang dbus-devel gtk2-devel libnotify-devel \
|
|
libgnome-keyring-devel xorg-x11-server-utils libcap-devel \
|
|
cups-devel libXtst-devel alsa-lib-devel libXrandr-devel \
|
|
GConf2-devel nss-devel
|
|
```
|
|
|
|
Other distributions may offer similar packages for installation via package
|
|
managers such as pacman. Or one can compile from source code.
|
|
|
|
## Getting the Code
|
|
|
|
```bash
|
|
$ git clone https://github.com/electron/electron
|
|
```
|
|
|
|
## Bootstrapping
|
|
|
|
The bootstrap script will download all necessary build dependencies and create
|
|
the build project files. You must have Python 2.7.x for the script to succeed.
|
|
Downloading certain files can take a long time. Notice that we are using
|
|
`ninja` to build Electron so there is no `Makefile` generated.
|
|
|
|
```bash
|
|
$ cd electron
|
|
$ ./script/bootstrap.py --verbose
|
|
```
|
|
|
|
### Cross compilation
|
|
|
|
If you want to build for an `arm` target you should also install the following
|
|
dependencies:
|
|
|
|
```bash
|
|
$ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \
|
|
g++-arm-linux-gnueabihf
|
|
```
|
|
|
|
And to cross-compile for `arm` or `ia32` targets, you should pass the
|
|
`--target_arch` parameter to the `bootstrap.py` script:
|
|
|
|
```bash
|
|
$ ./script/bootstrap.py -v --target_arch=arm
|
|
```
|
|
|
|
## Building
|
|
|
|
If you would like to build both `Release` and `Debug` targets:
|
|
|
|
```bash
|
|
$ ./script/build.py
|
|
```
|
|
|
|
This script will cause a very large Electron executable to be placed in
|
|
the directory `out/R`. The file size is in excess of 1.3 gigabytes. This
|
|
happens because the Release target binary contains debugging symbols.
|
|
To reduce the file size, run the `create-dist.py` script:
|
|
|
|
```bash
|
|
$ ./script/create-dist.py
|
|
```
|
|
|
|
This will put a working distribution with much smaller file sizes in
|
|
the `dist` directory. After running the `create-dist.py` script, you
|
|
may want to remove the 1.3+ gigabyte binary which is still in `out/R`.
|
|
|
|
You can also build the `Debug` target only:
|
|
|
|
```bash
|
|
$ ./script/build.py -c D
|
|
```
|
|
|
|
After building is done, you can find the `electron` debug binary under `out/D`.
|
|
|
|
## Cleaning
|
|
|
|
To clean the build files:
|
|
|
|
```bash
|
|
$ npm run clean
|
|
```
|
|
|
|
To clean only `out` and `dist` directories:
|
|
|
|
```bash
|
|
$ npm run clean-build
|
|
```
|
|
|
|
**Note:** Both clean commands require running `bootstrap` again before building.
|
|
|
|
## Troubleshooting
|
|
|
|
### Error While Loading Shared Libraries: libtinfo.so.5
|
|
|
|
Prebuilt `clang` will try to link to `libtinfo.so.5`. Depending on the host
|
|
architecture, symlink to appropriate `libncurses`:
|
|
|
|
```bash
|
|
$ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5
|
|
```
|
|
|
|
## Tests
|
|
|
|
See [Build System Overview: Tests](build-system-overview.md#tests)
|
|
|
|
## Advanced topics
|
|
|
|
The default building configuration is targeted for major desktop Linux
|
|
distributions. To build for a specific distribution or device, the following
|
|
information may help you.
|
|
|
|
### Building `libchromiumcontent` locally
|
|
|
|
To avoid using the prebuilt binaries of `libchromiumcontent`, you can build `libchromiumcontent` locally. To do so, follow these steps:
|
|
1. Install [depot_tools](https://chromium.googlesource.com/chromium/src/+/master/docs/linux_build_instructions.md#Install)
|
|
2. Install [additional build dependencies](https://chromium.googlesource.com/chromium/src/+/master/docs/linux_build_instructions.md#Install-additional-build-dependencies)
|
|
3. Fetch the git submodules:
|
|
|
|
```bash
|
|
$ git submodule update --init --recursive
|
|
```
|
|
4. Pass the `--build_release_libcc` switch to `bootstrap.py` script:
|
|
|
|
```bash
|
|
$ ./script/bootstrap.py -v --build_release_libcc
|
|
```
|
|
|
|
Note that by default the `shared_library` configuration is not built, so you can
|
|
only build `Release` version of Electron if you use this mode:
|
|
|
|
```bash
|
|
$ ./script/build.py -c R
|
|
```
|
|
|
|
### Using system `clang` instead of downloaded `clang` binaries
|
|
|
|
By default Electron is built with prebuilt
|
|
[`clang`](https://clang.llvm.org/get_started.html) binaries provided by the
|
|
Chromium project. If for some reason you want to build with the `clang`
|
|
installed in your system, you can call `bootstrap.py` with `--clang_dir=<path>`
|
|
switch. By passing it the build script will assume the `clang` binaries reside
|
|
in `<path>/bin/`.
|
|
|
|
For example if you installed `clang` under `/user/local/bin/clang`:
|
|
|
|
```bash
|
|
$ ./script/bootstrap.py -v --build_release_libcc --clang_dir /usr/local
|
|
$ ./script/build.py -c R
|
|
```
|
|
|
|
### Using compilers other than `clang`
|
|
|
|
To build Electron with compilers like `g++`, you first need to disable `clang`
|
|
with `--disable_clang` switch first, and then set `CC` and `CXX` environment
|
|
variables to the ones you want.
|
|
|
|
For example building with GCC toolchain:
|
|
|
|
```bash
|
|
$ env CC=gcc CXX=g++ ./script/bootstrap.py -v --build_release_libcc --disable_clang
|
|
$ ./script/build.py -c R
|
|
```
|
|
|
|
### Environment variables
|
|
|
|
Apart from `CC` and `CXX`, you can also set following environment variables to
|
|
custom the building configurations:
|
|
|
|
* `CPPFLAGS`
|
|
* `CPPFLAGS_host`
|
|
* `CFLAGS`
|
|
* `CFLAGS_host`
|
|
* `CXXFLAGS`
|
|
* `CXXFLAGS_host`
|
|
* `AR`
|
|
* `AR_host`
|
|
* `CC`
|
|
* `CC_host`
|
|
* `CXX`
|
|
* `CXX_host`
|
|
* `LDFLAGS`
|
|
|
|
The environment variables have to be set when executing the `bootstrap.py`
|
|
script, it won't work in the `build.py` script.
|