CRC module.

[ccan] / ccan / crc / _info.c

diff --git a/ccan/crc/_info.c b/ccan/crc/_info.c
new file mode 100644 (file)
index 0000000..d14d1a5
--- /dev/null
+++ b/ccan/crc/_info.c
@@ -0,0 +1,42 @@
+#include <string.h>
+
+/**
+ * crc - routines for crc of bytes
+ *
+ * Cyclic Redundancy Check routines.  They are reasonably fasts
+ * checksum routine, but not suitable for cryptographic use.
+ *
+ * They are useful for simple error detection, eg. a 32-bit CRC will
+ * detect a single error burst of up to 32 bits.
+ *
+ * Example:
+ *     #include <ccan/crc.h>
+ *     #include <stdio.h>
+ *     #include <stdlib.h>
+ *
+ *     int main(int argc, char *argv[])
+ *     {
+ *             if (argc != 2) {
+ *                     fprintf(stderr, "Usage: %s <string>\n"
+ *                             "Prints 32 bit CRC of the string\n", argv[0]);
+ *                     exit(1);
+ *             }
+ *             printf("0x%08x\n", crc32(argv[1], strlen(argv[1])));
+ *             exit(0);
+ *     }
+ *
+ * Licence: Public Domain
+ * Author: Gary S. Brown
+ * Maintainer: Rusty Russell <rusty@rustcorp.com.au>
+ */
+int main(int argc, char *argv[])
+{
+       if (argc != 2)
+               return 1;
+
+       if (strcmp(argv[1], "depends") == 0) {
+               return 0;
+       }
+
+       return 1;
+}