doc: minor crate feature doc cleanup

[brody4hire]

I think it reads a little better this way, no problem if any maintainers want to update as co-authors or need to reject this one.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.88%. Comparing base (fd92926) to head (0ff83bd).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2327   +/-   ##
=======================================
  Coverage   94.88%   94.88%           
=======================================
  Files         103      103           
  Lines       24204    24204           
=======================================
  Hits        22965    22965           
  Misses       1239     1239           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rustls-benchmarking]

Benchmark results

Instruction counts

Significant differences

There are no significant instruction count differences

Other differences

Click to expand

Scenario	Baseline	Candidate	Diff	Threshold
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_server	10735831	10690014	-45817 (-0.43%)	1.21%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client	8275644	8289297	13653 (0.16%)	0.85%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_server	10430469	10439490	9021 (0.09%)	0.96%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client	8288899	8294308	5409 (0.07%)	0.92%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_server	10710507	10716617	6110 (0.06%)	1.03%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client	3083181	3082470	-711 (-0.02%)	0.28%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client	3080483	3080746	263 (0.01%)	0.25%
handshake_no_resume_ring_1.3_ecdsap256_aes_client	3623446	3623237	-209 (-0.01%)	0.22%
handshake_no_resume_ring_1.3_ecdsap256_chacha_client	3624488	3624640	152 (0.00%)	0.23%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server	2160718	2160793	75 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server	2163796	2163761	-35 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_client	27857228	27857499	271 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_server	30390505	30390740	235 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_server	30390404	30390206	-198 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_server	28897706	28897885	179 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_client	28225060	28224890	-170 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_client	27798077	27797923	-154 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_client	27795521	27795394	-127 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_client	27861707	27861832	125 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_client	28198955	28199081	126 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server	1173059	1173063	4 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server	1175354	1175350	-4 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_client	27802313	27802400	87 (0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_server	28976094	28976009	-85 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_server	28895382	28895462	80 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_server	30387678	30387760	82 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_client	28192192	28192119	-73 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_client	28195122	28195058	-64 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_server	30430447	30430387	-60 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_server	30432851	30432908	57 (0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap256_aes_server	1610604	1610601	-3 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_server	28975940	28975887	-53 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_client	28228779	28228733	-46 (-0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap384_chacha_server	7565085	7565075	-10 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_server	28897696	28897675	-21 (-0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap384_chacha_client	35182662	35182637	-25 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_client	27854834	27854846	12 (0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap384_aes_client	35180743	35180730	-13 (-0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_server	28973735	28973726	-9 (-0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap384_aes_server	7562931	7562933	2 (0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_server	46471415	46471426	11 (0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap256_aes_server	46468546	46468536	-10 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_client	28221859	28221853	-6 (-0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_server	30433255	30433261	6 (0.00%)	0.20%
transfer_no_resume_ring_1.2_rsa_aes_server	46377334	46377341	7 (0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_server	80541176	80541185	9 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client	92696531	92696521	-10 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server	46457668	46457663	-5 (-0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_client	92666741	92666749	8 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_server	80644953	80644947	-6 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client	58235405	58235401	-4 (-0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap256_aes_client	58325517	58325513	-4 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_client	92702767	92702762	-5 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client	58232526	58232523	-3 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server	46465286	46465284	-2 (-0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_server	80536385	80536383	-2 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server	80641989	80641987	-2 (-0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server	80649613	80649611	-2 (-0.00%)	0.20%
transfer_no_resume_ring_1.3_rsa_aes_server	46468143	46468144	1 (0.00%)	0.20%
transfer_no_resume_ring_1.2_rsa_aes_client	58219740	58219741	1 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_client	58237485	58237484	-1 (-0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_client	58332659	58332660	1 (0.00%)	0.20%
transfer_no_resume_ring_1.3_rsa_aes_client	58336414	58336415	1 (0.00%)	0.20%
transfer_no_resume_ring_1.3_rsa_chacha_server	80535991	80535992	1 (0.00%)	0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_client	92657682	92657683	1 (0.00%)	0.20%
transfer_no_resume_ring_1.3_rsa_chacha_client	92668582	92668583	1 (0.00%)	0.20%
handshake_tickets_ring_1.3_rsa_chacha_client	40520810	40520810	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap384_aes_server	41612979	41612979	0 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.2_rsa_aes_server	5021182	5021182	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap384_aes_server	42075098	42075098	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_rsa_chacha_server	41974270	41974270	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap384_chacha_client	40196039	40196039	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_rsa_aes_client	40297353	40297353	0 (0.00%)	0.20%
handshake_no_resume_ring_1.3_rsa_aes_client	2654301	2654301	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap256_chacha_server	41494671	41494671	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap384_chacha_server	41494719	41494719	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_rsa_aes_client	40595000	40595000	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_client	40516810	40516810	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_rsa_chacha_server	41492560	41492560	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap384_chacha_client	40513549	40513549	0 (0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.2_rsa_aes_server	3874155	3874155	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_server	42074908	42074908	0 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_client	1716235	1716235	0 (0.00%)	0.20%
handshake_tickets_aws_lc_rs_1.2_rsa_aes_client	4216459	4216459	0 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_client	1931014	1931014	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap256_chacha_client	40198982	40198982	0 (0.00%)	0.20%
handshake_no_resume_ring_1.3_rsa_chacha_client	2660168	2660168	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_rsa_aes_server	41610820	41610820	0 (0.00%)	0.20%
handshake_no_resume_ring_1.3_rsa_chacha_server	11429435	11429435	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_rsa_chacha_client	40203033	40203033	0 (0.00%)	0.20%
handshake_no_resume_ring_1.3_ecdsap256_chacha_server	1611967	1611967	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap384_chacha_server	41976758	41976758	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap384_aes_client	40587739	40587739	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_client	40591000	40591000	0 (0.00%)	0.20%
handshake_session_id_aws_lc_rs_1.2_rsa_aes_client	3874375	3874375	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_server	41976568	41976568	0 (0.00%)	0.20%
handshake_tickets_ring_1.3_rsa_aes_server	42072610	42072610	0 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_server	46407039	46407039	0 (0.00%)	0.20%
handshake_no_resume_ring_1.2_rsa_aes_server	11290925	11290925	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap384_aes_client	40290359	40290359	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_server	41612931	41612931	0 (0.00%)	0.20%
handshake_no_resume_ring_1.2_rsa_aes_client	2561940	2561940	0 (0.00%)	0.20%
handshake_tickets_ring_1.2_rsa_aes_server	4699410	4699410	0 (0.00%)	0.20%
handshake_session_id_ring_1.2_rsa_aes_server	4235170	4235170	0 (0.00%)	0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_client	1924268	1924268	0 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client	92698766	92698766	0 (0.00%)	0.20%
handshake_tickets_ring_1.2_rsa_aes_client	4499013	4499013	0 (0.00%)	0.20%
handshake_no_resume_ring_1.3_rsa_aes_server	11423480	11423480	0 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_client	58175573	58175573	0 (0.00%)	0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_server	46460629	46460629	0 (0.00%)	0.20%
handshake_session_id_ring_1.2_rsa_aes_client	4238499	4238499	0 (0.00%)	0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_client	40293302	40293302	0 (0.00%)	0.20%

Wall-time

Significant differences

There are no significant wall-time differences

Other differences

Click to expand

Scenario	Baseline	Candidate	Diff	Threshold
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes	4.51 ms	4.44 ms	-0.08 ms (-1.69%)	4.88%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes	5.23 ms	5.14 ms	-0.08 ms (-1.60%)	4.44%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes	5.14 ms	5.07 ms	-0.07 ms (-1.33%)	6.38%
transfer_no_resume_ring_1.3_ecdsap256_aes	6.37 ms	6.29 ms	-0.08 ms (-1.32%)	4.30%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes	5.20 ms	5.13 ms	-0.07 ms (-1.26%)	7.20%
transfer_no_resume_ring_1.3_rsa_aes	6.87 ms	6.78 ms	-0.08 ms (-1.22%)	3.71%
transfer_no_resume_ring_1.2_rsa_aes	6.79 ms	6.71 ms	-0.08 ms (-1.20%)	3.70%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha	460.01 µs	455.40 µs	-4.60 µs (-1.00%)	3.30%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes	461.92 µs	457.44 µs	-4.48 µs (-0.97%)	3.88%
handshake_session_id_aws_lc_rs_1.2_rsa_aes	1.68 ms	1.67 ms	-0.01 ms (-0.89%)	2.42%
handshake_no_resume_ring_1.3_ecdsap256_aes	504.98 µs	500.52 µs	-4.46 µs (-0.88%)	2.12%
handshake_no_resume_ring_1.3_ecdsap256_chacha	501.74 µs	497.61 µs	-4.13 µs (-0.82%)	2.95%
transfer_no_resume_ring_1.3_ecdsap384_aes	9.48 ms	9.40 ms	-0.08 ms (-0.82%)	2.75%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha	13.69 ms	13.60 ms	-0.09 ms (-0.64%)	2.05%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha	12.99 ms	12.91 ms	-0.08 ms (-0.64%)	2.43%
transfer_no_resume_ring_1.3_rsa_chacha	13.51 ms	13.43 ms	-0.08 ms (-0.61%)	1.76%
transfer_no_resume_ring_1.3_ecdsap256_chacha	13.01 ms	12.93 ms	-0.08 ms (-0.60%)	2.22%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha	13.68 ms	13.60 ms	-0.08 ms (-0.56%)	2.84%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha	1.14 ms	1.13 ms	-0.01 ms (-0.51%)	2.52%
transfer_no_resume_ring_1.3_ecdsap384_chacha	16.12 ms	16.04 ms	-0.08 ms (-0.51%)	1.57%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes	1.15 ms	1.14 ms	-0.01 ms (-0.48%)	6.15%
handshake_no_resume_ring_1.3_rsa_aes	996.22 µs	992.16 µs	-4.06 µs (-0.41%)	1.22%
handshake_no_resume_ring_1.2_rsa_aes	993.06 µs	989.12 µs	-3.94 µs (-0.40%)	1.28%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha	1.16 ms	1.16 ms	-0.00 ms (-0.40%)	1.06%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes	1.11 ms	1.10 ms	-0.00 ms (-0.36%)	6.45%
handshake_tickets_ring_1.2_rsa_aes	1.61 ms	1.61 ms	-0.01 ms (-0.33%)	1.90%
handshake_no_resume_ring_1.3_rsa_chacha	995.15 µs	991.93 µs	-3.22 µs (-0.32%)	1.34%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha	4.30 ms	4.31 ms	0.01 ms (0.32%)	1.90%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes	5.03 ms	5.05 ms	0.02 ms (0.31%)	1.92%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha	5.00 ms	5.01 ms	0.02 ms (0.30%)	1.75%
handshake_session_id_ring_1.2_rsa_aes	1.53 ms	1.52 ms	-0.00 ms (-0.30%)	1.00%
handshake_tickets_aws_lc_rs_1.2_rsa_aes	1.85 ms	1.84 ms	-0.00 ms (-0.26%)	4.70%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha	4.99 ms	5.00 ms	0.01 ms (0.26%)	1.89%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha	4.50 ms	4.51 ms	0.01 ms (0.25%)	1.82%
handshake_tickets_ring_1.3_ecdsap256_aes	6.46 ms	6.44 ms	-0.02 ms (-0.24%)	1.00%
handshake_session_id_ring_1.3_ecdsap256_aes	6.39 ms	6.37 ms	-0.01 ms (-0.21%)	1.00%
handshake_tickets_aws_lc_rs_1.3_rsa_aes	5.22 ms	5.23 ms	0.01 ms (0.20%)	1.41%
handshake_session_id_aws_lc_rs_1.3_rsa_aes	5.03 ms	5.04 ms	0.01 ms (0.19%)	1.60%
handshake_session_id_ring_1.3_rsa_chacha	6.82 ms	6.81 ms	-0.01 ms (-0.19%)	1.00%
handshake_session_id_ring_1.3_rsa_aes	6.89 ms	6.87 ms	-0.01 ms (-0.18%)	1.05%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha	5.19 ms	5.20 ms	0.01 ms (0.17%)	1.59%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes	4.33 ms	4.34 ms	0.01 ms (0.17%)	2.10%
handshake_tickets_ring_1.3_ecdsap256_chacha	6.40 ms	6.39 ms	-0.01 ms (-0.16%)	1.00%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes	1.17 ms	1.17 ms	-0.00 ms (-0.16%)	1.02%
handshake_tickets_ring_1.3_ecdsap384_chacha	9.50 ms	9.48 ms	-0.01 ms (-0.15%)	1.00%
handshake_tickets_ring_1.3_rsa_aes	6.95 ms	6.94 ms	-0.01 ms (-0.15%)	1.00%
handshake_tickets_ring_1.3_ecdsap384_aes	9.55 ms	9.53 ms	-0.01 ms (-0.14%)	1.00%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes	5.24 ms	5.24 ms	0.01 ms (0.13%)	1.39%
handshake_tickets_ring_1.3_rsa_chacha	6.89 ms	6.88 ms	-0.01 ms (-0.12%)	1.00%
handshake_no_resume_ring_1.3_ecdsap384_chacha	3.61 ms	3.60 ms	-0.00 ms (-0.12%)	1.00%
handshake_session_id_ring_1.3_ecdsap384_chacha	9.43 ms	9.42 ms	-0.01 ms (-0.12%)	1.00%
handshake_no_resume_ring_1.3_ecdsap384_aes	3.61 ms	3.60 ms	-0.00 ms (-0.11%)	1.00%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes	4.54 ms	4.54 ms	0.00 ms (0.10%)	2.08%
handshake_session_id_ring_1.3_ecdsap384_aes	9.48 ms	9.47 ms	-0.01 ms (-0.09%)	1.00%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha	5.20 ms	5.20 ms	0.00 ms (0.07%)	1.77%
handshake_session_id_ring_1.3_ecdsap256_chacha	6.32 ms	6.32 ms	-0.00 ms (-0.07%)	1.00%

Additional information

Historical results

Checkout details:

• Base repo: https://github.com/rustls/rustls.git
• Base branch: main (fd92926)
• Candidate repo: https://github.com/brody4hire/rustls.git
• Candidate branch: minor-crate-feature-doc-cleanup (0ff83bd)