From ed244648d07fe0a97a5d75da903ed7aea0b3fd78 Mon Sep 17 00:00:00 2001 From: BobCochran Date: Thu, 4 Jun 2015 21:03:45 -0400 Subject: [PATCH 1/4] Update build instructions for Linux --- docs/development/build-instructions-linux.md | 45 ++++++++++++++++---- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 38918f19ad..06b1561743 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -2,8 +2,8 @@ ## Prerequisites -* Python 2.7 -* [Node.js](http://nodejs.org) +* Python 2.7.x +* [Node.js] (http://nodejs.org) * Clang 3.4 or later * Development headers of GTK+ and libnotify @@ -13,9 +13,23 @@ On Ubuntu you could install the libraries via: $ 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 \ - gcc-multilib g++-multilib + libxss1 gcc-multilib g++-multilib ``` +## If You Use Virtual Machines For Building + +If you plan to build electron on a virtual machine, you will need a fixed-size +device container of at least 25 gigabytes in size. The default disk sizes +suggested by VirtualBox are much too small. You will risk running out of space. +If creating a Ubuntu virtual machine under VirtualBox, do not partition the +disk using LVM, which is the Ubuntu installer default. Instead do all +partitioning with ext4 which is offered as an alternative to LVM. This way +if your vdi container does run out of space, you can use VirtualBox and gparted +utilities to increase the container size without needing to resize +LVM Volume Groups as an additional task. You may never have a need for LVM +in a virtual machine. + + ## Getting the code ```bash @@ -25,8 +39,9 @@ $ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so -there is no `Makefile` generated. +build project files. You must have Python 2.7.x for the script to succeed. +Downloading certain files could take a long time. Notice that we are using +`ninja` to build Electron so there is no `Makefile` generated. ```bash $ cd electron @@ -35,19 +50,33 @@ $ ./script/bootstrap.py -v ## Building -Build both `Release` and `Debug` targets: +If you would like to build both `Release` and `Debug` targets: ```bash $ ./script/build.py ``` -You can also only build the `Debug` target: +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 `atom` under `out/D`. +After building is done, you can find the `electron` debug binary +under `out/D`. ## Troubleshooting From 8a2b66509775151253eb95c91be9fcb1be93fcef Mon Sep 17 00:00:00 2001 From: BobCochran Date: Fri, 5 Jun 2015 19:38:30 -0400 Subject: [PATCH 2/4] Edit linux build instructions based on feedback --- docs/development/build-instructions-linux.md | 57 +++++--------------- 1 file changed, 12 insertions(+), 45 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 06b1561743..638ceb35ef 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -2,12 +2,16 @@ ## Prerequisites -* Python 2.7.x -* [Node.js] (http://nodejs.org) +* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x +so you may need to check your Python version with `python -V`. +* Node.js v0.12.x. There are various ways to install Node. One can download +source code from [Node.js] (http://nodejs.org) and compile from source. +Doing so permits installing Node to 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 3.4 or later * Development headers of GTK+ and libnotify -On Ubuntu you could install the libraries via: +On Ubuntu, install the following libraries: ```bash $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ @@ -16,6 +20,10 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libxss1 gcc-multilib g++-multilib ``` +Other distributions may offer similar packages for installation via package +managers such as yum. Or one can compile from source code. + + ## If You Use Virtual Machines For Building If you plan to build electron on a virtual machine, you will need a fixed-size @@ -80,48 +88,7 @@ under `out/D`. ## Troubleshooting -### fatal error: bits/predefs.h: No such file or directory - -If you got an error like this: - -```` -In file included from /usr/include/stdio.h:28:0, - from ../../../svnsrc/libgcc/../gcc/tsystem.h:88, - from ../../../svnsrc/libgcc/libgcc2.c:29: -/usr/include/features.h:324:26: fatal error: bits/predefs.h: No such file or directory - #include -```` - -Then you need to install `gcc-multilib` and `g++-multilib`, on Ubuntu you can do -this: - -```bash -$ sudo apt-get install gcc-multilib g++-multilib -``` - -### libudev.so.0 missing - -If you get an error like: - -```` -/usr/bin/ld: warning: libudev.so.0, needed by .../vendor/brightray/vendor/download/libchromiumcontent/Release/libchromiumcontent.so, not found (try using -rpath or -rpath-link) -```` - -and you are on Ubuntu 13.04+, 64 bit system, try doing - -```bash -sudo ln -s /lib/x86_64-linux-gnu/libudev.so.1.3.5 /usr/lib/libudev.so.0 -``` - -for ubuntu 13.04+ 32 bit systems, try doing - -```bash -sudo ln -s /lib/i386-linux-gnu/libudev.so.1.3.5 /usr/lib/libudev.so.0 -``` - -also see - -https://github.com/nwjs/nw.js/wiki/The-solution-of-lacking-libudev.so.0 +Make sure you have installed all the build dependencies. ## Tests From 40b6a1a37c2fde83625de2879c77ef0629745dcc Mon Sep 17 00:00:00 2001 From: BobCochran Date: Sat, 6 Jun 2015 18:04:11 -0400 Subject: [PATCH 3/4] Add instructions to clean build products --- docs/development/build-instructions-linux.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 638ceb35ef..5b9e0408e8 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -86,6 +86,17 @@ $ ./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 +$ ./script/clean.py +``` + + ## Troubleshooting Make sure you have installed all the build dependencies. From f776932718d6ce573af5a2b74b24288bc9aa9142 Mon Sep 17 00:00:00 2001 From: BobCochran Date: Sun, 7 Jun 2015 08:11:44 -0400 Subject: [PATCH 4/4] Edited virtual machines sections. --- docs/development/build-instructions-linux.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 5b9e0408e8..505cb4d5f0 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -27,15 +27,7 @@ managers such as yum. Or one can compile from source code. ## If You Use Virtual Machines For Building If you plan to build electron on a virtual machine, you will need a fixed-size -device container of at least 25 gigabytes in size. The default disk sizes -suggested by VirtualBox are much too small. You will risk running out of space. -If creating a Ubuntu virtual machine under VirtualBox, do not partition the -disk using LVM, which is the Ubuntu installer default. Instead do all -partitioning with ext4 which is offered as an alternative to LVM. This way -if your vdi container does run out of space, you can use VirtualBox and gparted -utilities to increase the container size without needing to resize -LVM Volume Groups as an additional task. You may never have a need for LVM -in a virtual machine. +device container of at least 25 gigabytes in size. ## Getting the code