diff --git a/README.getsentry.md b/README.getsentry.md new file mode 100644 index 000000000..cb499b1ae --- /dev/null +++ b/README.getsentry.md @@ -0,0 +1,20 @@ +# Sentry Modifications + +This is a fork of [Google Breakpad](https://chromium.googlesource.com/breakpad/breakpad/) maintained by Sentry for use in `sentry-native`. + +## Modifications + +- **Windows**: Dynamically size minidump paths instead of using `MAX_PATH` constant. +- **Windows**: Xbox One build support. +- **Linux**: Cast `SIGSTKSZ` to int for compatibility with glibc 2.34+ (where it's no longer a compile-time constant). +- **Build System**: CMake integration (see below). +- **macOS**: Extend the handler callback with a user-context (containing register state of the crash site) for x86_64 and arm64. +- **C++17 standard requirement**: upstream uses C++20 (or newer). + +## Build System Changes + +To minimize external dependencies and better integrate with `sentry-native`, this fork uses CMake instead of Breakpad's native Autotools/`configure` build system. + +The CMake build files are maintained in the parent [`sentry-native` repository](https://github.com/getsentry/sentry-native): + +- [`../../CMakeLists.txt`](https://github.com/getsentry/sentry-native/blob/master/CMakeLists.txt) - Defines the `breakpad_client` target and lists all source files diff --git a/README.md b/README.md index a9094a27a..d8ee553ef 100644 --- a/README.md +++ b/README.md @@ -80,3 +80,8 @@ dependent repos are up-to-date. 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. + +## Sentry modifications + +See [README.getsentry.md](README.getsentry.md) for more information on the +changes, and on maintaining the fork.