secp256k1.h: clarify that by default arguments must be != NULL #926

pull jonasnick wants to merge 1 commits into bitcoin-core:master from jonasnick:clarify-optional changing 1 files +3 −1

jonasnick commented at 5:02 PM on April 28, 2021: contributor

The same file says that the illegal callback will only triger for violations explicitly mentioned, which is not true without this commit because we often don't mention that an argument is not allowed to be NULL.

This line is extracted from #783 in the hope that it gets merged faster because other PRs depend on it.
gmaxwell commented at 10:42 PM on April 28, 2021: contributor

This seems fine to me, though FWIW, calling any the non-nullable inputs with a statically null input will cause warnings in the caller. And the non-nullable arguments should all be documented as non-nullable with the annotations in the header (though not in doxygen, indeed).
jonasnick force-pushed on Apr 29, 2021

secp256k1.h: clarify that by default arguments must be != NULL

The same file says that the illegal callback will only triger for violations
explicitly mentioned, which is not true without this commit because we often
don't mention that an argument is not allowed to be NULL.

0881633dfd

jonasnick commented at 10:22 AM on April 29, 2021: contributor

Agreed. Pushed an unrelated (slight) tweak.
real-or-random approved
real-or-random commented at 10:29 AM on April 29, 2021: contributor

ACK 0881633dfd0c530a915cf63be295f00841c94cc4
gmaxwell commented at 4:35 PM on May 7, 2021: contributor

ACK 0881633dfd0c530a915cf63be295f00841c94cc4
real-or-random merged this on May 7, 2021
real-or-random closed this on May 7, 2021
Fabcien referenced this in commit f5e54cd889 on Oct 22, 2024
Fabcien referenced this in commit d8917370bf on Oct 23, 2024
roqqit referenced this in commit 5210ba11e8 on Nov 20, 2024

Contributors

jonasnick

gmaxwell

real-or-random

Linked (view graph)

#783 Make the public API docs more consistent and explicit