aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_free.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /doc/man/libkeccak_state_free.3
parentChange style and license (diff)
downloadlibkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libkeccak_state_free.3')
-rw-r--r--doc/man/libkeccak_state_free.351
1 files changed, 0 insertions, 51 deletions
diff --git a/doc/man/libkeccak_state_free.3 b/doc/man/libkeccak_state_free.3
deleted file mode 100644
index e6dd3f8..0000000
--- a/doc/man/libkeccak_state_free.3
+++ /dev/null
@@ -1,51 +0,0 @@
-.TH LIBKECCAK_STATE_FREE 3 LIBKECCAK
-.SH NAME
-libkeccak_state_free - Destroys and deallocates a hash state with erasure
-.SH SYNOPSIS
-.LP
-.nf
-#include <libkeccak.h>
-.P
-void
-libkeccak_state_free(libkeccak_state_t *\fIstate\fP);
-.fi
-.P
-Link with
-.IR -lkeccak .
-.SH DESCRIPTION
-The
-.BR libkeccak_state_free ()
-function releases the allocations stored in
-.IR *state ,
-and also release the allocation of
-.IR state .
-.PP
-The
-.BR libkeccak_state_free ()
-function securely erases sensitive data.
-.SH RETURN VALUES
-The
-.BR libkeccak_state_free ()
-function does not return any value.
-.SH ERRORS
-The
-.BR libkeccak_state_free ()
-function cannot fail.
-.SH NOTES
-A double call to
-.BR libkeccak_state_free ()
-will either result in a double free,
-which is must likely to crash the process,
-or free an allocation (that was created
-between the calls) that was not intended
-to be freed, resulting in undefined behaviour.
-.SH SEE ALSO
-.BR libkeccak_state_destroy (3),
-.BR libkeccak_state_fast_free (3),
-.BR libkeccak_state_create (3),
-.BR libkeccak_state_initialise (3),
-.BR libkeccak_state_reset (3),
-.BR libkeccak_state_wipe (3)
-.SH BUGS
-Please report bugs to https://github.com/maandree/libkeccak/issues or to
-maandree@kth.se