diff --git a/docs/development/upgrading-chromium.md b/docs/development/upgrading-chromium.md index 3f450a85d86a..d00114338ab2 100644 --- a/docs/development/upgrading-chromium.md +++ b/docs/development/upgrading-chromium.md @@ -12,10 +12,11 @@ This is an overview of the steps needed to upgrade Chromium in Electron. ## Upgrade `libcc` to a new Chromium version 1. Get the code and initialize the project: - - ```sh + ```sh $ git clone git@github.com:electron/libchromiumcontent.git $ cd libchromiumcontent - $ ./script/bootstrap -v``` + $ ./script/bootstrap -v + ``` 2. Update the Chromium snapshot - Choose a version number from [OmahaProxy](https://omahaproxy.appspot.com/) and update the `VERSION` file with it @@ -47,18 +48,18 @@ This is an overview of the steps needed to upgrade Chromium in Electron. ## Update Electron's code 1. Get the code: - - ```sh - $ git clone git@github.com:electron/electron.git - $ cd electron - ``` + ```sh + $ git clone git@github.com:electron/electron.git + $ cd electron + ``` 2. If you have libcc built on your machine in its own repo, tell Electron to use it: - - ```sh - $ ./script/bootstrap.py -v \ - --libcc_source_path /src \ - --libcc_shared_library_path /shared_library \ - --libcc_static_library_path /static_library - ``` + ```sh + $ ./script/bootstrap.py -v \ + --libcc_source_path /src \ + --libcc_shared_library_path /shared_library \ + --libcc_static_library_path /static_library + ``` 3. If you haven't yet built libcc but it's already supposed to be upgraded to a new Chromium, bootstrap Electron as usual `$ ./script/bootstrap.py -v` diff --git a/docs/development/upgrading-node.md b/docs/development/upgrading-node.md index 108e36a52458..53e17c5cc6d1 100644 --- a/docs/development/upgrading-node.md +++ b/docs/development/upgrading-node.md @@ -82,7 +82,7 @@ We need to generate a patch file from each patch applied to V8. Manually edit the `.patch` file to match upstream V8's directory: - If a diff section has no instances of `deps/V8`, remove it altogether. - We don’t want those patches because we’re only patching V8. - - Replace instances of `a/deps/v8`/filename.ext` with `a/filename.ext` + - Replace instances of `a/deps/v8/filename.ext` with `a/filename.ext` - This is needed because upstream Node keeps its V8 files in a subdirectory - Ensure that local status is clean: `git status` to make sure there are no unstaged changes. - Confirm that the patch applies cleanly with @@ -105,20 +105,20 @@ We need to generate a patch file from each patch applied to V8. - `git commit patches/v8/` 8. Update `patches/v8/README.md` with references to all new patches that have been added so that the next person will know which need to be removed. 9. Update Electron's submodule references: - - ```sh - cd electron/vendor/node - electron/vendor/node$ git fetch - electron/vendor/node$ git checkout electron-node-vA.B.C - electron/vendor/node$ cd ../libchromiumcontent - electron/vendor/libchromiumcontent$ git fetch - electron/vendor/libchromiumcontent$ git checkout upgrade-to-chromium-X - electron/vendor/libchromiumcontent$ cd ../.. - electron$ git add vendor - electron$ git commit -m "update submodule referefences for node and libc" - electron$ git pso upgrade-to-chromium-62 - electron$ script/bootstrap.py -d - electron$ script/build.py -c -D - ``` + ```sh + $ cd electron/vendor/node + electron/vendor/node$ git fetch + electron/vendor/node$ git checkout electron-node-vA.B.C + electron/vendor/node$ cd ../libchromiumcontent + electron/vendor/libchromiumcontent$ git fetch + electron/vendor/libchromiumcontent$ git checkout upgrade-to-chromium-X + electron/vendor/libchromiumcontent$ cd ../.. + electron$ git add vendor + electron$ git commit -m "update submodule referefences for node and libc" + electron$ git pso upgrade-to-chromium-62 + electron$ script/bootstrap.py -d + electron$ script/build.py -c -D + ``` ## Notes @@ -143,16 +143,3 @@ We need to generate a patch file from each patch applied to V8. - Building node: - There’s a chance we need to change our build configuration to match the build flags that node wants in `node/common.gypi` - - - - - - - - - - - - -