OLD | NEW |
1 // Copyright 2015 The Crashpad Authors. All rights reserved. | 1 // Copyright 2015 The Crashpad Authors. All rights reserved. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
46 https://developer.apple.com/xcode/[Xcode], and for Windows, it’s | 46 https://developer.apple.com/xcode/[Xcode], and for Windows, it’s |
47 https://www.visualstudio.com/[Visual Studio]. | 47 https://www.visualstudio.com/[Visual Studio]. |
48 | 48 |
49 == Getting the Source Code | 49 == Getting the Source Code |
50 | 50 |
51 The main source code repository is a Git repository hosted at | 51 The main source code repository is a Git repository hosted at |
52 https://chromium.googlesource.com/crashpad/crashpad. Although it is possible to | 52 https://chromium.googlesource.com/crashpad/crashpad. Although it is possible to |
53 check out this repository directly with `git clone`, Crashpad’s dependencies are | 53 check out this repository directly with `git clone`, Crashpad’s dependencies are |
54 managed by | 54 managed by |
55 https://dev.chromium.org/developers/how-tos/depottools#TOC-gclient[`gclient`] | 55 https://dev.chromium.org/developers/how-tos/depottools#TOC-gclient[`gclient`] |
56 instead of Git submodules, so to work on Crashpad, it is best to use `gclient` | 56 instead of Git submodules, so to work on Crashpad, it is best to use `fetch` to |
57 to get the source code. | 57 get the source code. |
58 | 58 |
59 `gclient` is part of the | 59 `fetch` and `gclient` are part of the |
60 https://dev.chromium.org/developers/how-tos/depottools[depot_tools]. There’s no | 60 https://dev.chromium.org/developers/how-tos/depottools[depot_tools]. There’s no |
61 need to install it separately. | 61 need to install them separately. |
62 | 62 |
63 === Initial Checkout | 63 === Initial Checkout |
64 | 64 |
65 [subs="verbatim,quotes"] | 65 [subs="verbatim,quotes"] |
66 ---- | 66 ---- |
67 $ *mkdir \~/crashpad* | 67 $ *mkdir ~/crashpad* |
68 $ *cd ~/crashpad* | 68 $ *cd ~/crashpad* |
69 $ *gclient config --unmanaged https://chromium.googlesource.com/crashpad/crashpa
d* | 69 $ *fetch crashpad* |
70 $ *gclient sync* | |
71 ---- | 70 ---- |
72 | 71 |
| 72 `fetch crashpad` performs the initial `gclient sync`, establishing a |
| 73 fully-functional local checkout. |
| 74 |
73 === Subsequent Checkouts | 75 === Subsequent Checkouts |
74 | 76 |
75 [subs="verbatim,quotes"] | 77 [subs="verbatim,quotes"] |
76 ---- | 78 ---- |
77 $ *cd ~/crashpad/crashpad* | 79 $ *cd ~/crashpad/crashpad* |
78 $ *git pull -r* | 80 $ *git pull -r* |
79 $ *gclient sync* | 81 $ *gclient sync* |
80 ---- | 82 ---- |
81 | 83 |
82 == Building | 84 == Building |
83 | 85 |
84 Crashpad uses https://gyp.googlecode.com/[GYP] to generate | 86 Crashpad uses https://gyp.googlecode.com/[GYP] to generate |
85 https://martine.github.io/ninja/[Ninja] build files. The build is described by | 87 https://martine.github.io/ninja/[Ninja] build files. The build is described by |
86 `.gyp` files throughout the Crashpad source code tree. The | 88 `.gyp` files throughout the Crashpad source code tree. The |
87 `build/gyp_crashpad.py` script runs GYP properly for Crashpad, and is also | 89 `build/gyp_crashpad.py` script runs GYP properly for Crashpad, and is also |
88 called when you run `gclient sync` or `gclient runhooks`. | 90 called when you run `fetch crashpad`, `gclient sync`, or `gclient runhooks`. |
89 | 91 |
90 The Ninja build files and build output are in the `out` directory. Both debug- | 92 The Ninja build files and build output are in the `out` directory. Both debug- |
91 and release-mode configurations are available. The examples below show the debug | 93 and release-mode configurations are available. The examples below show the debug |
92 configuration. To build and test the release configuration, substitute `Release` | 94 configuration. To build and test the release configuration, substitute `Release` |
93 for `Debug`. | 95 for `Debug`. |
94 | 96 |
95 [subs="verbatim,quotes"] | 97 [subs="verbatim,quotes"] |
96 ---- | 98 ---- |
97 $ *cd ~/crashpad/crashpad* | 99 $ *cd ~/crashpad/crashpad* |
98 $ *ninja -C out/Debug* | 100 $ *ninja -C out/Debug* |
(...skipping 105 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
204 License Agreement] as appropriate before any submission can be accepted, and | 206 License Agreement] as appropriate before any submission can be accepted, and |
205 must be listed in the `AUTHORS` file. Contributors may be listed in the | 207 must be listed in the `AUTHORS` file. Contributors may be listed in the |
206 `CONTRIBUTORS` file. | 208 `CONTRIBUTORS` file. |
207 | 209 |
208 == Buildbot | 210 == Buildbot |
209 | 211 |
210 The https://build.chromium.org/p/client.crashpad/[Crashpad Buildbot] performs | 212 The https://build.chromium.org/p/client.crashpad/[Crashpad Buildbot] performs |
211 automated builds and tests of Crashpad. Before checking out or updating the | 213 automated builds and tests of Crashpad. Before checking out or updating the |
212 Crashpad source code, and after checking in a new change, it is prudent to check | 214 Crashpad source code, and after checking in a new change, it is prudent to check |
213 the Buildbot to ensure that “the tree is green.” | 215 the Buildbot to ensure that “the tree is green.” |
OLD | NEW |