[Python-checkins] cpython (3.5): Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT

[martin.panter]

https://hg.python.org/cpython/rev/a33472f8a2c6
changeset:   105800:a33472f8a2c6
branch:      3.5
user:        Martin Panter <vadmium+py at gmail.com>
date:        Sat Dec 24 07:36:44 2016 +0000
summary:
  Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT

files:
  Doc/library/binascii.rst    |  6 ++++--
  Modules/binascii.c          |  4 ++--
  Modules/clinic/binascii.c.h |  4 ++--
  3 files changed, 8 insertions(+), 6 deletions(-)


diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst
--- a/Doc/library/binascii.rst
+++ b/Doc/library/binascii.rst
@@ -115,8 +115,10 @@
 
 .. function:: crc_hqx(data, value)
 
-   Compute the binhex4 crc value of *data*, starting with *value* as the
-   initial crc, and return the result.
+   Compute a 16-bit CRC value of *data*, starting with *value* as the
+   initial CRC, and return the result.  This uses the CRC-CCITT polynomial
+   *x*:sup:`16` + *x*:sup:`12` + *x*:sup:`5` + 1, often represented as
+   0x1021.  This CRC is used in the binhex4 format.
 
 
 .. function:: crc32(data[, value])
diff --git a/Modules/binascii.c b/Modules/binascii.c
--- a/Modules/binascii.c
+++ b/Modules/binascii.c
@@ -915,12 +915,12 @@
     crc: unsigned_int(bitwise=True)
     /
 
-Compute hqx CRC incrementally.
+Compute CRC-CCITT incrementally.
 [clinic start generated code]*/
 
 static unsigned int
 binascii_crc_hqx_impl(PyObject *module, Py_buffer *data, unsigned int crc)
-/*[clinic end generated code: output=8ec2a78590d19170 input=add8c53712ccceda]*/
+/*[clinic end generated code: output=8ec2a78590d19170 input=f18240ff8c705b79]*/
 {
     unsigned char *bin_data;
     Py_ssize_t len;
diff --git a/Modules/clinic/binascii.c.h b/Modules/clinic/binascii.c.h
--- a/Modules/clinic/binascii.c.h
+++ b/Modules/clinic/binascii.c.h
@@ -246,7 +246,7 @@
 "crc_hqx($module, data, crc, /)\n"
 "--\n"
 "\n"
-"Compute hqx CRC incrementally.");
+"Compute CRC-CCITT incrementally.");
 
 #define BINASCII_CRC_HQX_METHODDEF    \
     {"crc_hqx", (PyCFunction)binascii_crc_hqx, METH_VARARGS, binascii_crc_hqx__doc__},
@@ -516,4 +516,4 @@
 
     return return_value;
 }
-/*[clinic end generated code: output=51173fc9718a5edc input=a9049054013a1b77]*/
+/*[clinic end generated code: output=6d70d5edd9373d92 input=a9049054013a1b77]*/

-- 
Repository URL: https://hg.python.org/cpython