OLD | NEW |
1 # Breakpad | 1 # Breakpad |
2 | 2 |
3 Breakpad is a set of client and server components which implement a | 3 Breakpad is a set of client and server components which implement a |
4 crash-reporting system. | 4 crash-reporting system. |
5 | 5 |
6 * [Homepage](https://chromium.googlesource.com/breakpad/breakpad/) | 6 * [Homepage](https://chromium.googlesource.com/breakpad/breakpad/) |
7 * [Documentation](https://chromium.googlesource.com/breakpad/breakpad/+/master/d
ocs/) | 7 * [Documentation](https://chromium.googlesource.com/breakpad/breakpad/+/master/d
ocs/) |
8 * [Bugs](https://bugs.chromium.org/p/google-breakpad/) | 8 * [Bugs](https://bugs.chromium.org/p/google-breakpad/) |
9 * Discussion/Questions: [google-breakpad-discuss@googlegroups.com](https://group
s.google.com/d/forum/google-breakpad-discuss) | 9 * Discussion/Questions: [google-breakpad-discuss@googlegroups.com](https://group
s.google.com/d/forum/google-breakpad-discuss) |
10 * Developer/Reviews: [google-breakpad-dev@googlegroups.com](https://groups.googl
e.com/d/forum/google-breakpad-dev) | 10 * Developer/Reviews: [google-breakpad-dev@googlegroups.com](https://groups.googl
e.com/d/forum/google-breakpad-dev) |
11 * Tests: [![Build Status](https://travis-ci.org/google/breakpad.svg?branch=maste
r)](https://travis-ci.org/google/breakpad) | 11 * Tests: [![Build Status](https://travis-ci.org/google/breakpad.svg?branch=maste
r)](https://travis-ci.org/google/breakpad) |
12 | 12 |
13 ## Getting started in 32-bit mode (from trunk) | 13 ## Getting started (from master) |
14 | 14 |
15 ```sh | 15 1. First, [download depot_tools](http://dev.chromium.org/developers/how-tos/ins
tall-depot-tools) |
16 # Configure | 16 and ensure that they're in your `PATH`. |
17 CXXFLAGS=-m32 CFLAGS=-m32 CPPFLAGS=-m32 ./configure | 17 |
18 # Build | 18 2. Create a new directory for checking out the source code (it must be named |
19 make | 19 breakpad). |
20 # Test | 20 |
21 make check | 21 ```sh |
22 # Install | 22 mkdir breakpad && cd breakpad |
23 make install | 23 ``` |
24 ``` | 24 |
| 25 3. Run the `fetch` tool from depot_tools to download all the source repos. |
| 26 |
| 27 ```sh |
| 28 fetch breakpad |
| 29 cd src |
| 30 ``` |
| 31 |
| 32 4. Build the source. |
| 33 |
| 34 ```sh |
| 35 ./configure && make |
| 36 ``` |
| 37 |
| 38 You can also cd to another directory and run configure from there to build |
| 39 outside the source tree. |
| 40 |
| 41 This will build the processor tools (`src/processor/minidump_stackwalk`, |
| 42 `src/processor/minidump_dump`, etc), and when building on Linux it will |
| 43 also build the client libraries and some tools |
| 44 (`src/tools/linux/dump_syms/dump_syms`, |
| 45 `src/tools/linux/md2core/minidump-2-core`, etc). |
| 46 |
| 47 5. Optionally, run tests. |
| 48 |
| 49 ```sh |
| 50 make check |
| 51 ``` |
| 52 |
| 53 6. Optionally, install the built libraries |
| 54 |
| 55 ```sh |
| 56 make install |
| 57 ``` |
25 | 58 |
26 If you need to reconfigure your build be sure to run `make distclean` first. | 59 If you need to reconfigure your build be sure to run `make distclean` first. |
27 | 60 |
28 ## To request change review: | 61 To update an existing checkout to a newer revision, you can |
| 62 `git pull` as usual, but then you should run `gclient sync` to ensure that the |
| 63 dependent repos are up-to-date. |
29 | 64 |
30 1. Get a copy of depot_tools repo. | 65 ## To request change review |
31 http://dev.chromium.org/developers/how-tos/install-depot-tools | |
32 | 66 |
33 2. Create a new directory for checking out the source code. | 67 1. Follow the steps above to get the source and build it. |
34 mkdir breakpad && cd breakpad | |
35 | 68 |
36 3. Run the `fetch` tool from depot_tools to download all the source repos. | 69 2. Make changes. Build and test your changes. |
37 `fetch breakpad` | |
38 | |
39 4. Make changes. Build and test your changes. | |
40 For core code like processor use methods above. | 70 For core code like processor use methods above. |
41 For linux/mac/windows, there are test targets in each project file. | 71 For linux/mac/windows, there are test targets in each project file. |
42 | 72 |
43 5. Commit your changes to your local repo and upload them to the server. | 73 3. Commit your changes to your local repo and upload them to the server. |
44 http://dev.chromium.org/developers/contributing-code | 74 http://dev.chromium.org/developers/contributing-code |
45 e.g. `git commit ... && git cl upload ...` | 75 e.g. `git commit ... && git cl upload ...` |
46 You will be prompted for credential and a description. | 76 You will be prompted for credential and a description. |
47 | 77 |
48 6. At https://codereview.chromium.org/ you'll find your issue listed; click on | 78 4. At https://codereview.chromium.org/ you'll find your issue listed; click on |
49 it, and select Publish+Mail, and enter in the code reviewer and CC | 79 it, and select Publish+Mail, and enter in the code reviewer and CC |
50 google-breakpad-dev@googlegroups.com | 80 google-breakpad-dev@googlegroups.com |
OLD | NEW |