scratch: rename max_size to size, document that extra will actually be allocated

This commit is contained in:
Andrew Poelstra
2019-03-14 14:41:03 +00:00
parent 5a4bc0bb95
commit a7a164f2c6
2 changed files with 6 additions and 5 deletions

View File

@@ -285,11 +285,12 @@ SECP256K1_API void secp256k1_context_set_error_callback(
*
* Returns: a newly created scratch space.
* Args: ctx: an existing context object (cannot be NULL)
* In: max_size: maximum amount of memory to allocate
* In: size: amount of memory to be available as scratch space. Some extra
* (<100 bytes) will be allocated for extra accounting.
*/
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT secp256k1_scratch_space* secp256k1_scratch_space_create(
const secp256k1_context* ctx,
size_t max_size
size_t size
) SECP256K1_ARG_NONNULL(1);
/** Destroy a secp256k1 scratch space.