Add documentation for WEBRTC_EXCLUDE_BUILT_IN_SSL_ROOT_CERTS.

Bug: webrtc:9332
Change-Id: I37a498ea9e97d84b49c29387de9efdf95b10d898
No-Try: True
Reviewed-on: https://webrtc-review.googlesource.com/94504
Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#24358}
This commit is contained in:
Mirko Bonadei 2018-08-16 15:09:59 +02:00 committed by Commit Bot
parent 803e3ff298
commit 4555c65388

View file

@ -65,3 +65,21 @@ types, functions, namespaces, etc. that have `impl` or `internal` in
their names (in various styles, such as `CamelCaseImpl`,
`snake_case_impl`). They are not part of the API, and may change
incompatibly at any time; do not use them.
# Preprocessor macros
The following preprocessor macros are read (but never set) by WebRTC; they allow
you to enable or disable parts of WebRTC at compile time.
Be sure to set them the same way in all translation units that include WebRTC
code.
## `WEBRTC_EXCLUDE_BUILT_IN_SSL_ROOT_CERTS`
If you want to ship your own set of SSL certificates and inject them into WebRTC
PeerConnections, you will probably want to avoid to compile and ship WebRTC's
default set of SSL certificates.
You can achieve this by defining the preprocessor macro
`WEBRTC_EXCLUDE_BUILT_IN_SSL_ROOT_CERTS`. If you use GN, you can just set the GN
argument `rtc_builtin_ssl_root_certificates` to false and GN will define the
macro for you.