From 6a38ace62c754e86eec2da8f37d606ce057d21ad Mon Sep 17 00:00:00 2001 From: whitequark Date: Wed, 15 Jul 2020 04:48:53 +0000 Subject: [PATCH] Improve docs for `DeviceCapabilities.checksum`. --- src/phy/mod.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/phy/mod.rs b/src/phy/mod.rs index b458543..47146b4 100644 --- a/src/phy/mod.rs +++ b/src/phy/mod.rs @@ -209,7 +209,10 @@ pub struct DeviceCapabilities { /// dynamically allocated. pub max_burst_size: Option, - /// The set of protocols for which checksum can be computed in hardware. + /// Checksum behavior. + /// + /// If the network device is capable of verifying or computing checksums for some protocols, + /// it can request that the stack not do so in software to improve performance. pub checksum: ChecksumCapabilities, /// Only present to prevent people from trying to initialize every field of DeviceLimits,