libiberty: Tweak the documentation of libiberty's xcrc32 function
authorPatrick Palka <patrick@parcs.ath.cx>
Mon, 28 Dec 2015 22:00:14 +0000 (22:00 +0000)
committerMike Frysinger <vapier@gentoo.org>
Tue, 5 Jan 2016 20:01:28 +0000 (15:01 -0500)
commit4bec0ef03e91506caf60d8842786b29c2d2ff049
tree09d0f407174fa9e41d6765ca423a5cbd948e906b
parent13b356b2b5c1857490b7911dbbb48e17a3a92b04
libiberty: Tweak the documentation of libiberty's xcrc32 function

In some places the xcrc32 documentation refers to GDB's own crc32
implementation, but GDB no longer has its own crc32 implementation.
It now uses libiberty's xcrc32 throughout.  So this patch removes
these references to GDB's now-nonexistent crc32 implementation.

Also, there appears to be a bug in the table-generation program embedded
within the documentation.  When the variable "int i" is >= 128, the
computation "i << 24" shifts a one bit into the sign bit (assuming a
32-bit int), which is UB.  To avoid this UB, I think it is sufficient to
make the induction variables i and j have type unsigned int.  This bug
seems latent, however.  I ran the program before and after this change
and the table output is the same.
libiberty/ChangeLog
libiberty/crc32.c