yuzu-emu/breakpad
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
breakpad/README.md
Sim Sun 2d3e030fdb readme: Change default branch from master to main 
The current default branch migrated to main, change the default branch in readme.

Change-Id: Ief1963f84419c094d79d5af8ec5bc21346b9e2b1
Reviewed-on: https://chromium-review.googlesource.com/c/breakpad/breakpad/+/2680719
Reviewed-by: Mike Frysinger <vapier@chromium.org>
2021-02-07 02:10:38 +00:00

2.9 KiB
Raw Blame History

Breakpad

Breakpad is a set of client and server components which implement a crash-reporting system.

Getting started (from main)

  1. First, download depot_tools and ensure that they’re in your PATH.

  2. Create a new directory for checking out the source code (it must be named breakpad).

    mkdir breakpad && cd breakpad

  3. Run the fetch tool from depot_tools to download all the source repos.

    fetch breakpad
cd src

  4. 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).

  5. Optionally, run tests.

    make check

  6. 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

  1. Follow the steps above to get the source and build it.

  2. 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.

  3. 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.

  4. At https://chromium-review.googlesource.com/ you'll find your issue listed; click on it, then “Add reviewer”, and enter in the code reviewer. Depending on your settings, you may not see an email, but the reviewer has been notified with google-breakpad-dev@googlegroups.com always CC’d.