8b7b28663f
Some of my colleagues have commented in the past few months that the Breakpad README is not very clear on how to get and build the code nowadays. This change moves some of the docs from the "request change review" section up to the "getting started" section, and adds a few more things to clarify. R=vapier@chromium.org BUG= Review URL: https://codereview.chromium.org/2035103002 . |
||
---|---|---|
android | ||
autotools | ||
docs | ||
m4 | ||
scripts | ||
src | ||
.gitignore | ||
.travis.yml | ||
aclocal.m4 | ||
AUTHORS | ||
breakpad-client.pc.in | ||
breakpad.pc.in | ||
ChangeLog | ||
codereview.settings | ||
configure | ||
configure.ac | ||
DEPS | ||
INSTALL | ||
LICENSE | ||
Makefile.am | ||
Makefile.in | ||
NEWS | ||
README.ANDROID | ||
README.md |
Breakpad
Breakpad is a set of client and server components which implement a crash-reporting system.
- Homepage
- Documentation
- Bugs
- Discussion/Questions: google-breakpad-discuss@googlegroups.com
- Developer/Reviews: google-breakpad-dev@googlegroups.com
- Tests:
Getting started (from master)
-
First, download depot_tools and ensure that they're in your
PATH
. -
Create a new directory for checking out the source code (it must be named breakpad).
mkdir breakpad && cd breakpad
-
Run the
fetch
tool from depot_tools to download all the source repos.fetch breakpad cd src
-
Build the source.
./configure && make
You can also cd to another directory and run configure from there to build outside the source tree.
This will build the processor tools (
src/processor/minidump_stackwalk
,src/processor/minidump_dump
, etc), and when building on Linux it will also build the client libraries and some tools (src/tools/linux/dump_syms/dump_syms
,src/tools/linux/md2core/minidump-2-core
, etc). -
Optionally, run tests.
make check
-
Optionally, install the built libraries
make install
If you need to reconfigure your build be sure to run make distclean
first.
To update an existing checkout to a newer revision, you can
git pull
as usual, but then you should run gclient sync
to ensure that the
dependent repos are up-to-date.
To request change review
-
Follow the steps above to get the source and build it.
-
Make changes. Build and test your changes. For core code like processor use methods above. For linux/mac/windows, there are test targets in each project file.
-
Commit your changes to your local repo and upload them to the server. http://dev.chromium.org/developers/contributing-code e.g.
git commit ... && git cl upload ...
You will be prompted for credential and a description. -
At https://codereview.chromium.org/ you'll find your issue listed; click on it, and select Publish+Mail, and enter in the code reviewer and CC google-breakpad-dev@googlegroups.com