chrome -> chromium and updates to crashpad doc

codebytere · codebytere · commit 178462b800fe · 2017-11-24T10:40:37.000+01:00
diff --git a/docs/development/upgrading-chromium.md b/docs/development/upgrading-chromium.md
@@ -1,4 +1,4 @@
-# Upgrading Chromium Workflow
+# Upgrading Chromium
 
 This document is meant to serve as an overview of what steps are needed
 on each Chromium upgrade in Electron.
diff --git a/docs/development/upgrading-crashpad.md b/docs/development/upgrading-crashpad.md
@@ -1,36 +1,42 @@
-- Get the version of crashpad that we're going to use.
-  - `libcc/src/third_party/crashpad/README.chromium` will have a line `Revision:` with a checksum.
-  - clone [Electron's Crashpad fork](https://github.com/electron/crashpad) and create a new branch
-  - `git clone https://chromium.googlesource.com/crashpad/crashpad`
-  - `git checkout 01110c0a3b`
-  - `git remote add electron https://github.com/electron/crashpad`
-  - `git checkout -b electron-crashpad-vA.B.C.D`
-     - `A.B.C.D` is the Chromium version found in `libcc/VERSION`
+# Upgrading Crashpad
+
+1. Get the version of crashpad that we're going to use.
+  - `libcc/src/third_party/crashpad/README.chromium` will have a line `Revision:` with a checksum
+    - We need to check out the correponding branch.
+  - Clone Google's crashpad (https://chromium.googlesource.com/crashpad/crashpad)
+    - `git clone https://chromium.googlesource.com/crashpad/crashpad`
+  - Check out the branch with the revision checksum:
+      - `git checkout <revision checksum>`
+  - Add electron's crashpad fork as a remote
+    - `git remote add electron https://github.com/electron/crashpad`
+  - Check out a new branch for the update
+    - `git checkout -b electron-crashpad-vA.B.C.D`
+    - `A.B.C.D` is the Chromium version found in `libcc/VERSION`
        and will be something like `62.0.3202.94`
 
-- Make a checklist of the Electron patches we need to apply
-  e.g. `git log --oneline`
-  or view http://github.com/electron/crashpad/commits/previous-branch-name
-- Foreach patch:
-  - (in new branch) `git cherry-pick checksum`
-  - resolve any conflicts
-  - make sure it builds
-  - add && commit
-- Push your work:
-  `git push electron electorn-crashpad-v62.0.3202.94`
+2. Make a checklist of the Electron patches that need to be applied
+  with `git log --oneline`
+    - Or view http://github.com/electron/crashpad/commits/previous-branch-name
+
+3. For each patch:
+  - In `electron-crashpad-vA.B.C.D`, cherry-pick the patch's checksum    
+    - `git cherry-pick <checksum>`
+  - Resolve any conflicts
+  - Make sure it builds then add, commit, and push work to electron's crashpad fork
+    - `git push electron electron-crashpad-vA.B.C.D`
 
-- Update Electron to build the new crashpad:
+4. Update Electron to build the new crashpad:
   - `cd vendor/crashpad`
   - `git fetch`
   - `git checkout electron-crashpad-v62.0.3202.94`
-- Regenerate Ninja files
-  - from Electron root's root, run `script/update.py`
+5. Regenerate Ninja files against both targets
+  - From Electron root's root, run `script/update.py`
   - `script/build.py -c D --target=crashpad_client`
   - `script/build.py -c D --target=crashpad_handler`
-  - If both of these work, it's probably good.
-- Push changes to submodule reference
-  - (from electron root) `git add vendor/crashpad`
+  - Both should build with no errors
+6. Push changes to submodule reference
+  - (From electron root) `git add vendor/crashpad`
   - `git push origin upgrade-to-chromium-62`
-  
+
 
 
diff --git a/docs/development/upgrading-node.md b/docs/development/upgrading-node.md
@@ -119,7 +119,7 @@ We need to generate a patch file from each patch applied to V8.
    electron$ script/build.py -c -D
    ```
 
-   
+
 
 ## Notes
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Upgrading Chromium Workflow`
	`1`	`+# Upgrading Chromium`
`2`	`2`
`3`	`3`	`This document is meant to serve as an overview of what steps are needed`
`4`	`4`	`on each Chromium upgrade in Electron.`