Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(251)

Side by Side Diff: README.md

Issue 2035103002: Make the getting started section in the README better (Closed) Base URL: https://chromium.googlesource.com/breakpad/breakpad.git@master
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 trunk)
vapier 2016/06/03 14:58:35 s/trunk/master/ ?
Ted Mielczarek 2016/06/03 16:40:40 Done.
14 14
15 ```sh 15 1. First, [download depot_tools](http://dev.chromium.org/developers/how-tos/ins tall-depot-tools) and ensure that they're in your `PATH`.
16 # Configure 16 2. Create a new directory for checking out the source code (it must be named br eakpad):
vapier 2016/06/03 14:58:35 i'd prefer to use a period at the end of each of t
Ted Mielczarek 2016/06/03 16:40:40 Done.
17 CXXFLAGS=-m32 CFLAGS=-m32 CPPFLAGS=-m32 ./configure 17
18 # Build 18 ```sh
19 make 19 mkdir breakpad && cd breakpad
20 # Test 20 ```
21 make check 21
22 # Install 22 3. Run the `fetch` tool from depot_tools to download all the source repos.
23 make install 23
24 ``` 24 ```sh
25 fetch breakpad
26 ```
27 4. Build the source:
vapier 2016/06/03 14:58:35 looks like you want a blank line above this (based
Ted Mielczarek 2016/06/03 16:40:40 Done.
28
29 ```sh
30 ./configure && make
31 ```
32
33 You can also cd to another directory and run configure from there to build o utside the source tree.
34
35 This will build the processor tools on all platforms (`src/processor/minidum p_stackwalk`, `src/processor/minidump_dump`, etc), and on Linux it will also bui ld the client libraries and some tools (`src/tools/linux/dump_syms/dump_syms`, ` src/tools/linux/md2core/minidump-2-core`, etc).
vapier 2016/06/03 14:58:35 line wrap to 80 cols ? the "on all platforms" is
Ted Mielczarek 2016/06/03 16:40:40 Done.
36 5. Run tests:
37
38 ```sh
39 make check
40 ```
41
42 6. To install the built libraries:
43
44 ```sh
45 make install
46 ```
25 47
26 If you need to reconfigure your build be sure to run `make distclean` first. 48 If you need to reconfigure your build be sure to run `make distclean` first.
27 49
50 To update an existing checkout to a newer revision, you can `git pull origin mas ter` as usual, but then you should run `gclient sync` to ensure that the depende nt repos are up-to-date.
vapier 2016/06/03 14:58:35 line wrap to 80 cols ? do you really need "origin
Ted Mielczarek 2016/06/03 16:40:40 Done. The remotes are normal, just all the git doc
51
28 ## To request change review: 52 ## To request change review:
vapier 2016/06/03 14:58:35 drop the trailing colon. it makes the TOC look we
Ted Mielczarek 2016/06/03 16:40:40 Done.
29 53
30 1. Get a copy of depot_tools repo. 54 1. Follow the steps above to get the source and build it.
31 http://dev.chromium.org/developers/how-tos/install-depot-tools
32 55
33 2. Create a new directory for checking out the source code. 56 2. Make changes. Build and test your changes.
34 mkdir breakpad && cd breakpad
35
36 3. Run the `fetch` tool from depot_tools to download all the source repos.
37 `fetch breakpad`
38
39 4. Make changes. Build and test your changes.
40 For core code like processor use methods above. 57 For core code like processor use methods above.
41 For linux/mac/windows, there are test targets in each project file. 58 For linux/mac/windows, there are test targets in each project file.
42 59
43 5. Commit your changes to your local repo and upload them to the server. 60 3. Commit your changes to your local repo and upload them to the server.
44 http://dev.chromium.org/developers/contributing-code 61 http://dev.chromium.org/developers/contributing-code
45 e.g. `git commit ... && git cl upload ...` 62 e.g. `git commit ... && git cl upload ...`
46 You will be prompted for credential and a description. 63 You will be prompted for credential and a description.
47 64
48 6. At https://codereview.chromium.org/ you'll find your issue listed; click on 65 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 66 it, and select Publish+Mail, and enter in the code reviewer and CC
50 google-breakpad-dev@googlegroups.com 67 google-breakpad-dev@googlegroups.com
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698