Skip to content

doc: clarify xgcd_vartime delegates to constant-time xgcd (pending #853) - #1333

Open
LuisCastellanos-dev wants to merge 3 commits into
RustCrypto:masterfrom
LuisCastellanos-dev:doc/xgcd-vartime-ct-delegation-warning
Open

doc: clarify xgcd_vartime delegates to constant-time xgcd (pending #853)#1333
LuisCastellanos-dev wants to merge 3 commits into
RustCrypto:masterfrom
LuisCastellanos-dev:doc/xgcd-vartime-ct-delegation-warning

Conversation

@LuisCastellanos-dev

@LuisCastellanos-dev LuisCastellanos-dev commented Aug 8, 2026

Copy link
Copy Markdown

xgcd_vartime for Uint, NonZeroUint and OddUint currently calls xgcd (CT)
due to #853. This is not documented, so callers expecting VT performance get CT
silently, and will silently change from CT to VT when #853 is implemented.

This adds an explicit NOTE explaining the current delegation and warning about
the future semantics change.

No code or logic change — documentation only.

No functional change in release build.

@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.06%. Comparing base (af17982) to head (2717a6d).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1333   +/-   ##
=======================================
  Coverage   91.06%   91.06%           
=======================================
  Files         189      189           
  Lines       22654    22654           
=======================================
  Hits        20630    20630           
  Misses       2024     2024           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant