Commit graph

479 commits

Author SHA1 Message Date
Islam ElHakmi
261f385b5e
docs: mention build-tools in the build instructions (#23909) 2020-06-08 08:59:19 -07:00
DeeDeeG
9f21d09dfd
docs: remove upgrading-node.md (#23802) 2020-05-29 12:12:35 -07:00
Jeremy Apthorp
3584665a8f
docs: remove sccache info from build instructions (#23297) 2020-04-28 09:17:50 -07:00
Erick Zhao
a3ff5a810e
docs: remove GitHub references (#23136) 2020-04-20 08:33:00 -07:00
Felix Rieseberg
b4447be037
docs: Update the "Electron vs NW.js" document (#22836)
* docs: Update the "Electron vs NW.js" document

* Update docs/development/electron-vs-nwjs.md

Co-Authored-By: Charles Kerr <ckerr@github.com>

* Update docs/development/electron-vs-nwjs.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

* Update docs/development/electron-vs-nwjs.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

Co-authored-by: Charles Kerr <ckerr@github.com>
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
2020-04-07 18:31:40 -07:00
Charles Kerr
33ef0d23a6
docs: minor grammar & spelling fixes (#22851)
* docs: fix minor grammar error 'punctuations'

* docs: fix minor grammar error pluralizing Chromium

* docs: fix typo 'updateCurrentActiviy'

* docs: use consistent spelling of 'behavior'

* docs: use 'macOS' instead of 'Mac OS' or 'OS X'.

* docs: use 'GTK' instead of 'GTK+'

https://mail.gnome.org/archives/gtk-devel-list/2019-February/msg00000.html

* docs: minor capitalization: use 'TCP' not 'tcp'

* Update docs/development/build-instructions-linux.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

Co-authored-by: Mark Lee <malept@users.noreply.github.com>
Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
2020-03-31 13:06:25 +09:00
Samuel Attard
a53a2aaa45
build: we moved goma to build-tools (#22488)
* build: we moved goma to build-tools

* Apply suggestions from code review

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

* build: do not use goma.gn

Co-authored-by: Mark Lee <malept@users.noreply.github.com>
2020-03-03 23:17:39 -08:00
Shelley Vohr
02cf5baa32
test: throw if no valid outDir (#22412) 2020-02-27 19:32:09 +00:00
Jeremy Apthorp
360326ecad
docs: update dev docs atom -> shell (#22199) 2020-02-17 09:47:22 +09:00
Ian Goodacre
e8517065d1
docs: add links to the issue tracker, to developer/issues (#21945)
* docs: add links to the issue tracker

Adding links to the issue tracker for existing issues and submission of
new issues makes it easier to do what is otherwise well described in the
issues doc.

There are direct links to the issue tracker in other introductory docs,
so I see no reason not to have them here, to facilitate access.

* docs: update issues TOC

* Changes recommended by malept
2020-01-31 14:50:05 +09:00
Erick Zhao
ae0064d787
docs: remove references to inaccessible team pages (#21923) 2020-01-28 22:16:42 +00:00
loc
f34cbe66a0 docs: add .lldbinit to macOS debugging docs (#21879)
* docs: add .lldbinit to macOS debugging docs

* fix lint by adding language to fenced code block

* remove trailing whitespace 😑
2020-01-27 08:10:25 -08:00
bitdisaster
467d7457be docs: details to run unit tests on Windows (#21840)
* document how to get unit tests running

* chore: fix styles

* chore: add lang fence

Co-authored-by: Cheng Zhao <zcbenz@github.com>
2020-01-24 10:51:09 +09:00
Shelley Vohr
3019a2650d
docs: ignore_locks not break_repo_locks (#21775) 2020-01-14 20:50:37 -08:00
Felix Rieseberg
2d0bf81bd4 docs: Little fix in Goma docs (#21762)
* docs: Little fix in Goma docs

* docs: Remove space
2020-01-14 11:04:08 -05:00
Samuel Attard
80a037db86
chore: update goma documentation (#21761) 2020-01-13 15:49:29 -08:00
Shelley Vohr
2e7f9bffeb
docs: update source code dir structure (#21659) 2020-01-12 21:08:00 -08:00
Jorn
aef9ab1bb7 Es6ify api docs (#21686)
* docs: es6ify docs -> var -> const / let

* docs: apply arrow functions throughout all of the docs
2020-01-13 10:29:46 +09:00
Samuel Attard
e18acb4380
build: document electron goma usage and add the external binaries (#21622) 2020-01-07 10:35:52 -08:00
Tierney Cyren
6df7bd63e4 docs: improve Windows build variable documentation (#20548)
* docs: improve Windows build variable documentation

Documents an additional and possibly unclear variable, `DRIVE:`, in the example global variables for building with Windows

* docs: update formatting in build-instructions-windows.md to align with styleguide
2019-12-06 08:53:50 +09:00
Cheng Zhao
0a741670a9
chore: remove native_mate (Part 14) (#21365)
* chore: remove uses of mate::Dictionary and mate::Handle

* chore: move CreateConstructor to gin_helper

* chore: remove native_mate

* chore: remove unneeded gin patch
2019-12-05 18:46:34 +09:00
Vlad Hashimoto
601cc6e887 docs: change invalid bash session language tag (#20827) 2019-11-12 12:47:56 +00:00
Samuel Attard
b06a479240
build: remove debug builds (#21016)
* build: remove debug builds

* Update docs/development/debugging-instructions-macos.md

Co-Authored-By: Robo <hop2deep@gmail.com>
2019-11-07 11:51:44 -08:00
John Kleinschmidt
04da8a10eb
docs: document JS constant naming (#20892) 2019-11-04 13:25:43 -05:00
Jeremy Apthorp
6781d5e3c8
test: there is only --ci (#20794) 2019-10-30 16:38:21 -07:00
Kerollos Magdy
8efa45d12d docs: fix minor grammar mistakes (#20521) 2019-10-14 14:35:52 +09:00
Jeremy Apthorp
df1d3156a0
docs: remove outdated document about updating chromium (#20490) 2019-10-09 16:07:15 -07:00
Jeremy Apthorp
c75c3ef616
docs: add a dev doc describing the patch system (#20489) 2019-10-09 14:48:09 -07:00
Felix Rieseberg
b3e7657159 docs: Update the sccache name (#20462) 2019-10-08 17:46:01 -04:00
Andrew MacDonald
7f320eef0e docs: Minor fixes to build instructions (#20338)
* Minor fixes to build instructions

* Direct folks to the unit testing page.
2019-10-04 10:11:51 -04:00
Erick Zhao
2cac40444b docs: clarify VS installation instructions for Windows builds (#20236)
* docs: note required step for VS in Windows build

* docs: add instructions for custom VS location

* lint?

* link chromium docs
2019-09-17 10:23:56 -04:00
Micha Hanselmann
9b1f698770 docs: mention QuickEdit in Windows troubleshooting (#19701)
* shot a trouble

* change title
2019-08-14 14:23:12 -07:00
Richard Townsend
58840f39bb docs: document device scaling issue (#19387) 2019-08-08 13:59:44 -07:00
Valentin Hăloiu
0732da1b4a build: remove GConf and dconf dependencies on linux (#19498) 2019-07-29 08:33:47 -04:00
Richard Townsend
9711fc895e docs: describe how to install Meiryo (#19308)
Fixes #19201
2019-07-18 10:51:34 -07:00
Shelley Vohr
3d2eb8360a chore: remove tls check script (#19280) 2019-07-16 12:04:02 -07:00
Thiago de Arruda
d0ece2bc93 docs: Add command to quickly fix the SMBv2 cache (#19210)
Running this command is more convenient than manually editing regedit.
2019-07-15 17:57:33 +09:00
Charles Kerr
c9bc4aeb90 docs: remove redundant 'set origin' section (#19243)
* docs: fix remote push origin docs

* docs: remove redundant section

the 'git remote' text in the 'Getting the Code' section is better
2019-07-15 17:42:11 +09:00
小菜
641e1d6587 doc: change pyobjc link in macos build instruction (#18471) 2019-06-03 18:57:13 -07:00
Richard Townsend
3c8acf3687 build: bring in a later compiler for Windows on Arm (#18591)
* build: allow pulling in a later version of Clang

Due to a code-generation defect related to virtual method thunks in the
official compiler used for Chromium M76, it's necessary to build for WoA
with a later version of Clang. When running gclient sync, setting
ELECTRON_BUILD_WOA=1 in the environment will download a corrected
compiler which doesn't have this defect.

* docs: add a note about building for Windows on Arm
2019-06-03 17:29:25 -04:00
Shelley Vohr
8759e30f04
build: linux needs java on GN (#18211)
The linux builds fails with ./bin/sh java not found unless this is installed.
2019-05-08 15:28:55 -07:00
Michelle Tilley
4808f30538
fix: revert to previous documentation folder structure (#18127) 2019-05-02 15:17:17 -07:00
Shelley Vohr
5ed11aa1f3
docs: remove obsolete releasing document (#18072) 2019-05-01 09:14:14 -07:00
Shelley Vohr
6530c99cfa
docs: add azure vm spinup tutorial (#17958) 2019-04-25 15:42:45 -07:00
Shelley Vohr
2108044bdb
docs: move organizational info docs to new directory (#17865)
* docs: move organizational info docs to new directory

* fix some markdown lint issues
2019-04-25 15:14:19 -07:00
Milan Burda
0b0f677432 docs: make gclient config command Windows friendly (#17900) 2019-04-23 05:11:35 -04:00
Samuel Attard
50b9933705 build: update circle base image and mac docs for 10.13 SDK 2019-04-02 14:43:03 -07:00
Milan Burda
a82bbd010e build: strip trailing whitespace in docs (#17488) 2019-03-20 13:12:47 -07:00
Seba Kerckhof
b7fc50b7ca docs: Add information on packaging a build (#17086)
* docs: Add information on packaging a build

* Stripping only applies to linux
2019-03-08 15:24:00 -08:00
Jeremy Apthorp
5a88d9e6fc
docs: add troubleshooting note about pywin32 (#17216) 2019-03-05 10:40:52 -08:00
Jeremy Apthorp
67f04c0370 docs: remove dead link to chromiumdev slack (#17161)
* docs: remove dead link to chromiumdev slack

Closes #17154

* Update chromium-development.md
2019-02-28 16:43:55 -05:00
Tomas Rycl
1db4dd68a7 Troubleshooting for Windows Driver Kit (#16405) 2019-01-23 12:34:18 -08:00
SamvelRaja
34c1727cb3 docs: fix typo in build instructions for windows (#16414) 2019-01-15 21:58:39 -08:00
John Kleinschmidt
50010934d1
docs: Update reference to xcode 8.3.3 (#16267)
* Update reference to xcode

* Update to reflect use of 10.12 SDK
2019-01-04 13:05:12 -05:00
Michelle Tilley
46c2953edb doc: Update Windows build instructions to include debugging tools (#15765) 2018-11-20 01:08:25 -05:00
Simone Cattaneo
f2d3d55e95 docs: changed German link with English one for Windows SDK Archive (#15764) 2018-11-20 01:03:03 -05:00
Jeremy Apthorp
ec4212cce1
docs: add troubleshooting section for win toolchain prompt (#15761) 2018-11-19 11:53:28 -08:00
Milan Burda
8ba271efba refactor: eliminate brightray (#15240) 2018-10-24 12:49:10 +02:00
Martin Mädler
a4fefbe836 docs: update Windows build instructions (#14797) 2018-10-22 16:40:39 -04:00
Felix Rieseberg
ca826d49a5 docs: Add instructions on how to pull/push (#14903)
* docs: Add instructions on how to pull/push

* docs: Implement feedback <3

* fix: typo s/glient/gclient
2018-10-10 15:48:37 +11:00
Samuel Attard
e86298d5d9
chore: fix relative links in docs and enforce we dont break them again (#14832) 2018-09-28 13:16:38 +10:00
Samuel Attard
55765424f9 chore: fix test command in docs 2018-09-28 11:19:00 +10:00
Samuel Attard
2adb44a402 chore: remove unused files to simply out_dir replacements 2018-09-28 11:16:37 +10:00
Shelley Vohr
e9549a89bb
docs: update releasing info (#14675)
* docs: update releasing info

* update more release and upload files

* address feedback from review
2018-09-24 09:12:16 -07:00
Samuel Attard
6b50dc8745
docs: add python-dbusmock to the linux requirements (#14727)
Refs #14726
2018-09-20 21:41:00 +10:00
Jeremy Apthorp
b8a8bf82ac
docs: update "upgrading node" guide (#14649)
I think there's more to do here, and I'll continue to add to & update this documentation as I go through the process of upgrading node in the context of the GN build.
2018-09-19 11:08:39 -07:00
Samuel Attard
558fff69e7
chore: update to standard 12 2018-09-14 14:57:01 +10:00
Jeremy Apthorp
9e85bdb02c docs: prefer out/Debug to out/Default in build docs 2018-09-13 15:08:31 -07:00
Jeremy Apthorp
ebbaa4f89b docs: simplify git cache instructions (#14562) 2018-09-12 12:06:55 +10:00
Jeremy Apthorp
b35c8e4e1e docs: update instructions for building win32 target (#14560) 2018-09-12 12:05:51 +10:00
Jeremy Apthorp
0ab95b76a7
docs: add note about origin URLs to GN build docs (#14530) 2018-09-10 12:31:41 -07:00
Jeremy Apthorp
72526927d9 build: remove gyp build files (#14097)
* build: remove gyp build files

* docs: update build instructions

* build: temporary restore electron.gyp

* build: do not update Electron version in the electron.gyp

* chore: remove unused submodules

* ci: remove obsolete CI scripts and configs

* chore: remove obsolete scripts

* chore: remove obsolete functions from lib/util.py

* ci: send Slack notification for nightly build results
2018-09-09 10:15:32 +09:00
Charles Kerr
2b4dbe409f fix: doc recipe for debug build (#14355) 2018-08-29 09:31:06 -07:00
Charles Kerr
e315e4d308 build: use electron-frameworks sccache (#14171)
* build: update-external-binaries fetches sccache

* build: add util.add_exec_bit in scripts/

* build: use util.add_exec_bit in create-dist

* build: use util.add_exec_bit in update-external-binaries

this is needed to work around a bug in python's zipfile module that doesn't preserve the exec bit

https://bugs.python.org/issue18262

* fix: linting errors

* build: vsts, circleci use patched sccache

* build: always look for the x64 sccache

as it's the only arch we have it on

* fix: windows-specific errors in updaste-external-binaries

* fix: tyop

* fix: set SCCACHE_BUCKET, SCCACHE_TWO_TIER on circleci

* fix: syntax error in circleci yaml

* fix: keep churning

* chore: add tracer to file downloader

* docs: add sccache instructions for GN builds

* build: pull down the darwin sccache on mas builds

* build: use gn sync verbosely on circleci and vsts

* docs: copyediting

* build: remove unnecessary cache-dir arg

* docs: fix shell quoting in gn build instructions

* fix: invoke gclient without -verbose in circleci

* refactor: remove debug tracer

* fix: invoke gclient without -verbose in appveyor

* fix: invoke gclient without -verbose in vsts

* fix: pull add_exec_bit from correct source

* fix: remove 'SCCACHE_TWO_TIER' from CI scripts

* refactor: remove SCCACHE_BUCKET from ci scripts

this environment variable will be set via the CI UI instead

* refactor: clarify log message

* fix: set SCCACHE_PATH correctly for Windows CI
2018-08-21 15:40:06 -04:00
Charles Kerr
51b76f0635 build: use GIT_CACHE_PATH (#14165)
* build: add GIT_CACHE_PATH

The merge at https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/1105473 was to specify git cache entirely from the environment variable  [and] removal of the general --cache-dir option from gclient

* docs: document GIT_CACHE_PATH in GN build

* fix: try to fix appveyor-gn env syntax
2018-08-17 09:20:20 -07:00
John Kleinschmidt
dda6bb135a
Merge pull request #14017 from electron/node-gn
build: build node with GN
2018-08-14 14:29:17 -07:00
Shelley Vohr
c0959bd534
refactor: add 'npm run bootstrap', 'npm run build' (#14034)
* docs: update package.json and build docs

* fix build release

* address feedback from review

* whoops forgot one

* fix build script

* address feedback from review
2018-08-12 14:01:46 -07:00
Jeremy Apthorp
ae79fd1bb3 docs: update GN developer docs (#14018) 2018-08-11 12:20:19 -05:00
Jeremy Apthorp
6d277ec784 [wip] build: try building node with GN 2018-08-10 10:06:27 -07:00
Jeremy Apthorp
2551837ffb
docs: min windows server version for building is 2012 (#13935) 2018-08-03 17:32:07 -07:00
Jeremy Apthorp
379998e2f6
docs: recommend windows 10 as the minimum build OS
I'm pretty sure building on windows 7 doesn't work.
2018-08-03 15:42:12 -07:00
deepak1556
e0735baff2 docs: [gn] update build instructions 2018-08-03 11:54:21 -07:00
Shelley Vohr
48ae9b7a9c
docs: update node upgrade doc (#13891)
Updates the node upgrade doc to take path changes into account as well as to incorporate the new `get-patch` script which simplifies work significantly.
2018-08-01 23:33:37 -07:00
Jeremy Apthorp
0efb5853d6 build: [gn] centralize GN args under build/args/*.gn
Devs can still locally override or add settings by adding lines after
the `import` statement in args.gn.

This will help make sure that everyone has a common set of build args,
and will allow us to update everyone's build args in git.
2018-07-25 14:24:45 -07:00
Tiago Danin
1fd6d38a0a docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
Jeremy Apthorp
16b66db9c7 build: [gn] working on 32bit windows 2018-07-19 17:04:44 -07:00
Samuel Attard
f26880db03 Update docs on semantic requirements for #13359 (#13365) 2018-07-18 10:41:58 -05:00
John Kleinschmidt
05538aa32c
Merge pull request #13629 from electron/use-dot-env
docs: use .env (and .env.example) for tokens used in release
2018-07-17 11:57:42 -04:00
John Kleinschmidt
cc03213b62
Merge pull request #13664 from electron/tweak-release-docs
docs: update release docs from Fri 13 release session
2018-07-16 16:22:30 -04:00
John Kleinschmidt
5764d76efa Fix formatting
Add alternate url for security token (depends on whether you are using new or old navigation on VSTS)
2018-07-16 10:39:31 -04:00
John Kleinschmidt
87f34ccda4 Update Windows VS2017 requirement (#13663) 2018-07-13 17:43:27 -05:00
Charles Kerr
3653730cba Add post-publish 'npm dist-tag ls electron' step 2018-07-13 16:17:02 -05:00
John Kleinschmidt
6ea0e73b47
Merge branch 'master' into use-dot-env 2018-07-13 16:02:49 -04:00
Charles Kerr
da92abf964 document ELECTRON_S3_ tokens 2018-07-13 14:42:36 -05:00
Charles Kerr
452b5f342c add note about multiple calls to validateRelease 2018-07-13 14:17:31 -05:00
Charles Kerr
02d072ed9d fix VSTS token generation URL 2018-07-13 13:47:40 -05:00
John Kleinschmidt
6b5ccec0c6 chore: Updates for release process (#13632)
* Fix Appveyor URL

* Update docs to reflect current process

Also added troubleshooting steps.
2018-07-12 07:53:07 -05:00
Zeke Sikelianos
849cddf4be update tokens portion of releasing docs 2018-07-11 11:02:41 -07:00
Jeremy Apthorp
4f8acb0cdd docs: add link to Chromium windows debugging docs
I found this tidbit in particular helpful: 

```sh
> devenv /debugexe out\Debug\chrome.exe <options to Chromium can go here>
```
2018-06-27 23:06:30 +02:00
Samuel Attard
28d148b475
docs: add native_mate to source code directory structure doc (#13451) 2018-06-27 17:46:14 +10:00