changeset 39711:e693c621c472

maint: clarify comments about sticky EOF * lib/af_alg.c: Be more direct that we can't assume stickiness of EOF for portability reasons. * lib/md5.c: Clarify that this isn't just a glibc issue. * lib/sha1.c: Likewise. * lib/sha256.c: Likewise. * lib/sha512.c: Likewise.
author Pádraig Brady <P@draigBrady.com>
date Sun, 24 Jun 2018 15:15:16 -0700
parents 191b096795a6
children 250d25415d0e
files ChangeLog lib/af_alg.c lib/md5.c lib/sha1.c lib/sha256.c lib/sha512.c
diffstat 6 files changed, 23 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Jun 25 00:25:31 2018 +0200
+++ b/ChangeLog	Sun Jun 24 15:15:16 2018 -0700
@@ -1,3 +1,13 @@
+2018-06-24  Pádraig Brady  <P@draigBrady.com>
+
+	maint: clarify comments about sticky EOF
+	* lib/af_alg.c: Be more direct that we can't
+	assume stickiness of EOF for portability reasons.
+	* lib/md5.c: Clarify that this isn't just a glibc issue.
+	* lib/sha1.c: Likewise.
+	* lib/sha256.c: Likewise.
+	* lib/sha512.c: Likewise.
+
 2018-06-24  Bruno Haible  <bruno@clisp.org>
 
 	af_alg: Comment and style improvements.
--- a/lib/af_alg.c	Mon Jun 25 00:25:31 2018 +0200
+++ b/lib/af_alg.c	Sun Jun 24 15:15:16 2018 -0700
@@ -146,7 +146,7 @@
               break;
             }
 
-          /* Assume EOF is not sticky. See:
+          /* Don't assume that EOF is sticky. See:
              <https://sourceware.org/bugzilla/show_bug.cgi?id=19476>.  */
           if (feof (stream))
             {
--- a/lib/md5.c	Mon Jun 25 00:25:31 2018 +0200
+++ b/lib/md5.c	Sun Jun 24 15:15:16 2018 -0700
@@ -172,7 +172,9 @@
         {
           /* Either process a partial fread() from this loop,
              or the fread() in afalg_stream may have gotten EOF.
-             We need to avoid a subsequent fread() due to glibc BZ 1190.  */
+             We need to avoid a subsequent fread() as EOF may
+             not be sticky.  For details of such systems, see:
+             https://sourceware.org/bugzilla/show_bug.cgi?id=1190  */
           if (feof (stream))
             goto process_partial_block;
 
--- a/lib/sha1.c	Mon Jun 25 00:25:31 2018 +0200
+++ b/lib/sha1.c	Sun Jun 24 15:15:16 2018 -0700
@@ -160,7 +160,9 @@
         {
           /* Either process a partial fread() from this loop,
              or the fread() in afalg_stream may have gotten EOF.
-             We need to avoid a subsequent fread() due to glibc BZ 1190.  */
+             We need to avoid a subsequent fread() as EOF may
+             not be sticky.  For details of such systems, see:
+             https://sourceware.org/bugzilla/show_bug.cgi?id=1190  */
           if (feof (stream))
             goto process_partial_block;
 
--- a/lib/sha256.c	Mon Jun 25 00:25:31 2018 +0200
+++ b/lib/sha256.c	Sun Jun 24 15:15:16 2018 -0700
@@ -210,7 +210,9 @@
         {
           /* Either process a partial fread() from this loop,
              or the fread() in afalg_stream may have gotten EOF.
-             We need to avoid a subsequent fread() due to glibc BZ 1190.  */
+             We need to avoid a subsequent fread() as EOF may
+             not be sticky.  For details of such systems, see:
+             https://sourceware.org/bugzilla/show_bug.cgi?id=1190  */
           if (feof (stream))
             goto process_partial_block;
 
--- a/lib/sha512.c	Mon Jun 25 00:25:31 2018 +0200
+++ b/lib/sha512.c	Sun Jun 24 15:15:16 2018 -0700
@@ -211,7 +211,9 @@
         {
           /* Either process a partial fread() from this loop,
              or the fread() in afalg_stream may have gotten EOF.
-             We need to avoid a subsequent fread() due to glibc BZ 1190.  */
+             We need to avoid a subsequent fread() as EOF may
+             not be sticky.  For details of such systems, see:
+             https://sourceware.org/bugzilla/show_bug.cgi?id=1190  */
           if (feof (stream))
             goto process_partial_block;