mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

make some things more explicit and style conformity

Browse source
This commit is contained in:
Shelley Vohr 2017-11-24 11:06:04 +01:00
parent 178462b800
commit ba6224039c
No known key found for this signature in database
GPG key ID: F13993A75599653C
1 changed files with 47 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

123
docs/development/upgrading-chromium.md
View file

@ -12,43 +12,38 @@ on each Chromium upgrade in Electron.
## Upgrade `libcc` to a new Chromium ## Upgrade `libcc` to a new Chromium
### Steps 1. Get the code and initialize the project:
### 1. Get the code and initialize the project: - ```sh
```sh $ git clone git@github.com:electron/libchromiumcontent.git
$ git clone git@github.com:electron/libchromiumcontent.git $ cd libchromiumcontent
$ cd libchromiumcontent $ ./script/bootstrap -v```
$ ./script/bootstrap -v 2. Find the new beta/stable Chromium version from [OmahaProxy](https://omahaproxy.appspot.com/).
``` 3. Put it into the `libchromiumcontent/VERSION` file, then run `$ ./script/update`
### 2. Find the new beta/stable Chromium version from [OmahaProxy](https://omahaproxy.appspot.com/).
### 3. Put it into the `libchromiumcontent/VERSION` file, then run `$ ./script/update`
- It will probably fail applying patches. - It will probably fail applying patches.
### 4. Fix `*.patch` files in the `/patches` and `/patches-mas` folders. 4. Fix `*.patch` files in the `/patches` and `/patches-mas` folders.
### 5. (Optional) Run a separate script to apply patches (`script/update` uses it internally): 5. (Optional) Run a separate script to apply patches (`script/update` uses it internally):
```sh - `$ ./script/apply-patches`
$ ./script/apply-patches - There is also another script `/script/patch.py` that could be more useful
``` - Check `--help` to learn how it works with `$ ./script/patch.py -h`
- There is also another script `/script/patch.py` that could be more useful, check `--help` to learn how it works with `$ ./script/patch.py -h` 6. Run the build when all patches can be applied without errors
### 6. Run the build when all patches can be applied without errors - `$ ./script/build`
```sh
$ ./script/build
```
- If some patches are no longer compatible with the Chromium code, fix compilation errors. - If some patches are no longer compatible with the Chromium code, fix compilation errors.
### 7. When build succeeds, create a `dist` for Electron 7. When build succeeds, create a `dist` for Electron
`$ ./script/create-dist --no_zip` - `$ ./script/create-dist --no_zip`
- It will create `dist/main` folder in the root of the libcc repo, you will need it to build Electron. - It will create `dist/main` folder in the root of the libcc repo
### 8. (Optional) Update script contents if there are errors resultant of some files being removed or renamed. (`--no_zip` prevents script from create `dist` archives, you don't need them.) - You will need it to build Electron.
8. (Optional) Update script contents if there are errors resultant of some files being removed or renamed. (`--no_zip` prevents script from create `dist` archives, you don't need them.)
## Update Electron Code ## Update Electron Code
### Steps 1. Get the code:
### 1. Get the code: - ```sh
```sh $ git clone git@github.com:electron/electron.git
$ git clone git@github.com:electron/electron.git $ cd electron
$ cd electron ```
``` 2. If you already have libcc built on you machine in its own repo, you need to tell Electron explicitly to use it:
### 2. If you already have libcc built on you machine in its own repo, you need to tell Electron explicitly to use it: - ```sh
```sh
$ ./script/bootstrap.py -v \ $ ./script/bootstrap.py -v \
--libcc_source_path <libcc_folder>/src \ --libcc_source_path <libcc_folder>/src \
--libcc_shared_library_path <libcc_folder>/shared_library \ --libcc_shared_library_path <libcc_folder>/shared_library \
@ -58,19 +53,21 @@ $ cd electron
`$ ./script/bootstrap.py -v` `$ ./script/bootstrap.py -v`
- Ensure that libcc submodule (`vendor/libchromiumcontent`) points to a right revision - Ensure that libcc submodule (`vendor/libchromiumcontent`) points to a right revision
### 3. Set CLANG_REVISION in` script/update-clang.sh` to match the version Chromium is using. 3. Set CLANG_REVISION in` script/update-clang.sh` to match the version Chromium is using.
- Located in `electron/libchromiumcontent/src/tools/clang/scripts/update.py` - Located in `electron/libchromiumcontent/src/tools/clang/scripts/update.py`
### 4. Checkout Chromium if you haven't already: https://chromium.googlesource.com/chromium/src.git/+/{VERSION}/tools/clang/scripts/update.py 4. Checkout Chromium if you haven't already:
- https://chromium.googlesource.com/chromium/src.git/+/{VERSION}/tools/clang/scripts/update.py
- (Replace the `{VERSION}` placeholder in the url above to the Chromium version libcc uses.) - (Replace the `{VERSION}` placeholder in the url above to the Chromium version libcc uses.)
### 5. Build Electron. 5. Build Electron.
- Try to build Debug version first: `$ ./script/build.py -c D` - Try to build Debug version first: `$ ./script/build.py -c D`
- You will need it to run tests - You will need it to run tests
### 6. Fix compilation and linking errors 6. Fix compilation and linking errors
### 7. Ensure that Release build can be built too: `$ ./script/build.py -c R` 7. Ensure that Release build can be built too
- `$ ./script/build.py -c R`
- Often the Release build will have different linking errors that you'll need to fix. - Often the Release build will have different linking errors that you'll need to fix.
- Some compilation and linking errors are caused by missing source/object files in the libcc `dist` - Some compilation and linking errors are caused by missing source/object files in the libcc `dist`
### 8. Update `./script/create-dist` in the libcc repo, recreate a `dist`, and run Electron bootstrap script once again. 8. Update `./script/create-dist` in the libcc repo, recreate a `dist`, and run Electron bootstrap script once again.
### Tips for fixing compilation errors ### Tips for fixing compilation errors
- Fix build config errors first - Fix build config errors first
@ -87,54 +84,22 @@ Fix the failing tests.
Follow all the steps above to fix Electron code on all supported platforms. Follow all the steps above to fix Electron code on all supported platforms.
## Update Crashpad ## Updating Crashpad
- Electron's crashpad fork: https://github.com/electron/crashpad If there are any compilation errors related to the Crashpad, it probably means you need to update the fork to a newer revision: see [Upgrading Crashpad](https://github.com/electron/electron/tree/master/docs/development/upgrading-crashpad.md) for instructions on how to do that.
- Primary crashpad repo: https://chromium.googlesource.com/crashpad/crashpad/
### Steps ## Updating NodeJS
If there are any compilation errors related to the Crashpad, it probably means you need to update the fork to a newer revision:
### 1. Clone Electron's fork of the Crashpad, add the main repo as another remote: Upgrade `vendor/node` to the Node release that corresponds to the v8 version being used in the new Chromium release. See the v8 versions in Node on
```sh
$ git clone https://github.com/electron/crashpad && cd crashpad
$ git remote add upstream https://chromium.googlesource.com/crashpad/crashpad/ && git fetch upstream
```
### 2. Find a revision Chromium uses in src/third_party/crashpad/README.chromium
### 3. Rebase the master branch to that REVISION
```sh
$ git rebase REVISION
```
- If there are nontrivial conflicts during rebase, consult with the commit's author.
### 4. Add a tag with the next Electron version to a top commit in the master branch
- e.g. if current Electron version is `1.11.*`, then use tag `electron-1.12.0`, because it will be used in the next version.
### 5. Ensure Electron-specific commits in the master branch on GitHub are properly tagged
- If they aren't, force push will make them orphans and they'll be lost.
### 6. Force push to Electron's crashpad fork.
### 7. Update `/vendor/crashpad` submodule in the Electron's upgrade branch to point to the updated crashpad.
See [Upgrading Node](https://github.com/electron/electron/tree/master/docs/development/upgrading-node.md) for instructions on how to do this.
## Update NodeJS
- Upgrade `vendor/node` to the Node release that corresponds to the v8 version
being used in the new Chromium release. See the v8 versions in Node on
https://nodejs.org/en/download/releases for more details.
- You can find v8 version Chromium is using on [OmahaProxy](http://omahaproxy.appspot.com).
If it's not available check `v8/include/v8-version.h`
in the Chromium checkout.
## Verify ffmpeg Support ## Verify ffmpeg Support
Electron ships with a version of `ffmpeg` that includes proprietary codecs by Electron ships with a version of `ffmpeg` that includes proprietary codecs by default. A version without these codecs is built and distributed with each release as well. Each Chrome upgrade should verify that switching this version is still supported.
default. A version without these codecs is built and distributed with each
release as well. Each Chrome upgrade should verify that switching this version is
still supported.
You can verify Electron's support for multiple `ffmpeg` builds by loading the You can verify Electron's support for multiple `ffmpeg` builds by loading the following page. It should work with the default `ffmpeg` library distributed with Electron and not work with the `ffmpeg` library built without proprietary codecs.
following page. It should work with the default `ffmpeg` library distributed
with Electron and not work with the `ffmpeg` library built without proprietary
codecs.
```html ```html
<!DOCTYPE html> <!DOCTYPE html>