]> git.codecow.com Git - Monocypher.git/commit
Removed "cannot fail" from the manual
authorLoup Vaillant <loup@loup-vaillant.fr>
Sat, 21 Apr 2018 18:31:22 +0000 (20:31 +0200)
committerLoup Vaillant <loup@loup-vaillant.fr>
Sat, 21 Apr 2018 18:31:22 +0000 (20:31 +0200)
commitd574d18a08ef3db4e639b8bacdcb8a413a1313ef
tree56ab42361f7497537b7097a82bb3373519ae04e4
parent4c1836af879d2e05d287caf2c32a491754efeaf3
Removed "cannot fail" from the manual

This is C we're talking about.  Functions that return void cannot fail
only if they're used correctly.  Incorrect inputs can still trigger
undefined behaviour.  In this sense, those functions _can_ fail.

Returning void should be an obvious enough hint that the function
requires no error handling. At least it is if you're familiar enough
with C. (If one is not, one is not qualified to use a crypto library in
an unsafe language.)

An unqualified "cannot fail" give any more information than `void`, and
may even mislead some users.  Better stay on the safe side.
doc/man/man3/crypto_argon2i.3monocypher
doc/man/man3/crypto_blake2b.3monocypher
doc/man/man3/crypto_chacha20_H.3monocypher
doc/man/man3/crypto_chacha20_encrypt.3monocypher
doc/man/man3/crypto_key_exchange.3monocypher
doc/man/man3/crypto_lock.3monocypher
doc/man/man3/crypto_lock_init.3monocypher
doc/man/man3/crypto_poly1305.3monocypher
doc/man/man3/crypto_sign.3monocypher
doc/man/man3/crypto_sign_init_first_pass.3monocypher
doc/man/man3/crypto_wipe.3monocypher