From caecc36a99b50e4acc11afe8a195096a63353f6d Mon Sep 17 00:00:00 2001
From: Graham Percival <gperciva@tarsnap.com>
Date: Mon, 10 Jun 2024 09:32:15 -0700
Subject: [PATCH] comments: fix API arg descriptions

SHA256_arm: W and S should have been removed in:
    2021-02-19 sha256: don't pass W and S to SHA256_Transform_arm
    05ebafdd870e30e49e5715331414ebcd9e3a1233

SHA256_sse2: W and S should have been included in:
    2021-02-06 sha256_sse2: add
    192d05beba9502601496102ee89258afc534387d

util/entropy.h: ${er} should not have been included in:
    2020-09-22 entropy: expose _init(), _fill(), _done()
    ceaae6784dbc836ca2a789765510ed60c25cd555
---
 libcperciva/alg/sha256_arm.c  | 5 ++---
 libcperciva/alg/sha256_arm.h  | 5 ++---
 libcperciva/alg/sha256_sse2.c | 2 +-
 libcperciva/alg/sha256_sse2.h | 2 +-
 libcperciva/util/entropy.h    | 2 +-
 5 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/libcperciva/alg/sha256_arm.c b/libcperciva/alg/sha256_arm.c
index e3e5f6b1..96223f4d 100644
--- a/libcperciva/alg/sha256_arm.c
+++ b/libcperciva/alg/sha256_arm.c
@@ -49,12 +49,11 @@ static const uint32_t Krnd[64] = {
 	X0 = vsha256su1q_u32(vsha256su0q_u32(X0, X1), X2, X3)
 
 /**
- * SHA256_Transform_arm(state, block, W, S):
+ * SHA256_Transform_arm(state, block):
  * Compute the SHA256 block compression function, transforming ${state} using
  * the data in ${block}.  This implementation uses ARM SHA256 instructions,
  * and should only be used if _SHA256 is defined and cpusupport_arm_sha256()
- * returns nonzero.  The arrays W and S may be filled with sensitive data, and
- * should be cleared by the callee.
+ * returns nonzero.
  */
 #ifdef POSIXFAIL_ABSTRACT_DECLARATOR
 void
diff --git a/libcperciva/alg/sha256_arm.h b/libcperciva/alg/sha256_arm.h
index 4c39b6cf..d9ed3fab 100644
--- a/libcperciva/alg/sha256_arm.h
+++ b/libcperciva/alg/sha256_arm.h
@@ -4,12 +4,11 @@
 #include <stdint.h>
 
 /**
- * SHA256_Transform_arm(state, block, W, S):
+ * SHA256_Transform_arm(state, block):
  * Compute the SHA256 block compression function, transforming ${state} using
  * the data in ${block}.  This implementation uses ARM SHA256 instructions,
  * and should only be used if _SHA256 is defined and cpusupport_arm_sha256()
- * returns nonzero.  The arrays W and S may be filled with sensitive data, and
- * should be cleared by the callee.
+ * returns nonzero.
  */
 #ifdef POSIXFAIL_ABSTRACT_DECLARATOR
 void SHA256_Transform_arm(uint32_t state[8], const uint8_t block[64]);
diff --git a/libcperciva/alg/sha256_sse2.c b/libcperciva/alg/sha256_sse2.c
index 35b58d2f..d2575534 100644
--- a/libcperciva/alg/sha256_sse2.c
+++ b/libcperciva/alg/sha256_sse2.c
@@ -167,7 +167,7 @@ MSG4(__m128i X0, __m128i X1, __m128i X2, __m128i X3)
 }
 
 /**
- * SHA256_Transform_sse2(state, block):
+ * SHA256_Transform_sse2(state, block, W, S):
  * Compute the SHA256 block compression function, transforming ${state} using
  * the data in ${block}.  This implementation uses x86 SSE2 instructions, and
  * should only be used if _SSE2 is defined and cpusupport_x86_sse2() returns
diff --git a/libcperciva/alg/sha256_sse2.h b/libcperciva/alg/sha256_sse2.h
index 4035d388..16704cec 100644
--- a/libcperciva/alg/sha256_sse2.h
+++ b/libcperciva/alg/sha256_sse2.h
@@ -4,7 +4,7 @@
 #include <stdint.h>
 
 /**
- * SHA256_Transform_sse2(state, block):
+ * SHA256_Transform_sse2(state, block, W, S):
  * Compute the SHA256 block compression function, transforming ${state} using
  * the data in ${block}.  This implementation uses x86 SSE2 instructions, and
  * should only be used if _SSE2 is defined and cpusupport_x86_sse2() returns
diff --git a/libcperciva/util/entropy.h b/libcperciva/util/entropy.h
index ffe67cfe..abadfa94 100644
--- a/libcperciva/util/entropy.h
+++ b/libcperciva/util/entropy.h
@@ -25,7 +25,7 @@ int entropy_read_fill(struct entropy_read_cookie *, uint8_t *, size_t);
  * entropy_read_done(er):
  * Release any resources used by ${er}.
  */
-int entropy_read_done(struct entropy_read_cookie * er);
+int entropy_read_done(struct entropy_read_cookie *);
 
 /**
  * entropy_read(buf, buflen):