RustCrypto / RustCrypto/utils

cmov: add correct usage examples for both `Cmov` and `CmovEq`

Open
#921 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
674
Forks
170
Avg merge
1d 12h
Merged PRs (30d)
10

Description

I plan to get these done later today also, and they'll follow the tests as a rough example (but obviously cleaner, easier to understand and commented so users know what's going on).

I plan to add warnings about using Cmov directly, as it would act more of an optimisation barrier if a condition is set to x == y.

I may also add warnings about branching in general, and using the ^ operator where the functions provided by CmovEq aren't adequate (which will be extremely unlikely but still probably worth noting). I'll also briefly explain why using == is bad, but I'm no branching expert so that may require some tweaking.

I'll try to adhere to the RustCrypto example format in order to reduce PR review time, and for consistency.

I think I'll try and get #920 fixed up first though.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing tests for Cmov and CmovEq, then compare their structure with other RustCrypto examples. Add clear, commented usage examples for both APIs and document the cautions around direct Cmov use, == conditions, branching, and the ^ operator; the examples should follow the repository's established format.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.