diff --git a/docs/user-guide/debugging-gso.md b/docs/user-guide/debugging-gso.md index c8c0e8f3d..1d90f35a4 100644 --- a/docs/user-guide/debugging-gso.md +++ b/docs/user-guide/debugging-gso.md @@ -2,7 +2,7 @@ Generic Segmentation Offload (GSO) and Generic Receive Offload (GRO) are network stack features that can improve the efficiency of transmitting and receiving packets. GSO/GRO are enabled by default in `s2n-quic` on operating systems that have good support for these features (namely Linux variants). `s2n-quic` will also automatically disable these features if the operating system emits a socket error indicating they are not supported. -Some operating systems may silently fail when using GSO/GRO, leading to performance degradation. In these cases, `s2n-quic` will not automatically disable GSO/GRO. You can manually disable GSO/GRO on the IO provider to evaluate if that has a positive impact on performance: +Some operating systems and environments, such as Docker bridge networking, may silently fail when using GSO/GRO, leading to performance degradation or failures. In these cases, `s2n-quic` will not automatically disable GSO/GRO. You can manually disable GSO/GRO on the IO provider to evaluate if that has a positive impact on performance: ```rust let io = s2n_quic::provider::io::Default::builder() @@ -13,4 +13,6 @@ let io = s2n_quic::provider::io::Default::builder() let mut server = Server::builder() .with_io(io)? .start()?; -``` \ No newline at end of file +``` + +In the case of running tests in broken GSO environments, setting `S2N_QUIC_PLATFORM_FEATURES_OVERRIDE=""` as an environment variable will disable the feature. \ No newline at end of file