You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-30Lines changed: 37 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -192,19 +192,19 @@ using `cmake -D BUILD_SHARED_LIBS=OFF ..`.
192
192
When using `sentry` as a static library, make sure to `#define SENTRY_BUILD_STATIC 1` before including the sentry header.
193
193
194
194
-`SENTRY_PIC` (Default: ON):
195
-
By default, `sentry` is built as a positionindependent library.
195
+
By default, `sentry` is built as a position-independent library.
196
196
197
197
-`SENTRY_EXPORT_SYMBOLS` (Default: ON):
198
-
By default, `sentry` exposes all symbols in the dynamic symbol table. You might want to disable it in case the program intends to `dlopen` third-party shared libraries and avoid symbol collisions.
198
+
By default, `sentry` exposes all symbols in the dynamic symbol table. You might want to disable it if the program intends to `dlopen` third-party shared libraries and avoid symbol collisions.
199
199
200
200
-`SENTRY_BUILD_RUNTIMESTATIC` (Default: OFF):
201
201
Enables linking with the static MSVC runtime. Has no effect if the compiler is not MSVC.
202
202
203
203
-`SENTRY_LINK_PTHREAD` (Default: ON):
204
-
Links platform threads library like `pthread` on unix targets.
204
+
Links platform threads library like `pthread` on UNIX targets.
205
205
206
206
-`SENTRY_BUILD_FORCE32` (Default: OFF):
207
-
Forces cross-compilation from 64-bit host to 32-bit target. Only has an effect on Linux.
207
+
Forces cross-compilation from 64-bit host to 32-bit target. Only affects Linux.
208
208
209
209
-`CMAKE_SYSTEM_VERSION` (Default: depending on Windows SDK version):
210
210
Sets up a minimal version of Windows where sentry-native can be guaranteed to run.
@@ -238,52 +238,59 @@ using `cmake -D BUILD_SHARED_LIBS=OFF ..`.
238
238
only supported on Desktop OSs, and used as the default on Windows, Linux and macOS.
239
239
-**breakpad**: This uses the in-process breakpad handler. It is currently
240
240
only supported on Desktop OSs.
241
-
-**inproc**: A small in-process handler which is supported on all platforms,
242
-
and is used as default on Android.
241
+
-**inproc**: A small in-process handler that is supported on all platforms,
242
+
and is used as a default on Android.
243
243
-**none**: This builds `sentry-native` without a backend, so it does not handle
244
-
crashes at all. It is primarily used for tests.
244
+
crashes. It is primarily used for tests.
245
245
246
246
-`SENTRY_INTEGRATION_QT` (Default: OFF):
247
247
Builds the Qt integration, which turns Qt log messages into breadcrumbs.
248
248
249
249
-`SENTRY_BREAKPAD_SYSTEM` (Default: OFF):
250
-
This instructs the build system to use system-installed breakpad libraries instead of using the in-tree version.
250
+
This instructs the build system to use system-installed breakpad libraries instead of the in-tree version.
251
251
252
252
-`SENTRY_TRANSPORT_COMPRESSION` (Default: OFF):
253
253
Adds Gzip transport compression. Requires `zlib`.
254
254
255
-
| Feature | Windows | macOS | Linux | Android | iOS |
-`*`: `inproc` has not produced valid stack traces on macOS since version 13 ("Ventura"). Tracking: https://github.com/getsentry/sentry-native/issues/906
289
+
-`**`: `breakpad` on Android and iOS builds and should work according to upstream but is untested.
290
+
-`***`: `curl` as a transport works on Android but isn't used in any supported configuration to reduce the size of our artifacts.
291
+
292
+
In addition to platform support, the "Advanced Usage" section of the SDK docs now [describes the tradeoffs](https://docs.sentry.io/platforms/native/advanced-usage/backend-tradeoffs/) involved in choosing a suitable backend for a particular use case.
293
+
287
294
### Build Targets
288
295
289
296
-`sentry`: This is the main library and the only default build target.
0 commit comments