diff --git a/README.md b/README.md index ce21525b..4e7102e9 100644 --- a/README.md +++ b/README.md @@ -644,10 +644,10 @@ TODO: also trawl through Go's bug tracker for "this image failed to load". *Preliminary* `puffs bench` throughput numbers for the GIF codec are below. Higher is better. -"Mimic" tests check that Puffs' output mimics exactly other libraries' output -(i.e. giflib for GIF, libpng for PNG, etc.). "Mimic" benchmarks are the numbers -for those other libraries, as shipped with the OS, measured here on Ubunty -14.04 LTS "Trusty". +"Mimic" tests check that Puffs' output mimics (i.e. exactly matches) other +libraries' output, such as giflib for GIF, libpng for PNG, etc. "Mimic" +benchmarks give the numbers for those other libraries, as shipped with the OS, +measured here on Ubunty 14.04 LTS "Trusty". The 1k, 10k, etc. numbers are approximately how many bytes of pixel data there is in the decoded image. For example, the `test/testdata/harvesters.*` images diff --git a/test/c/std/gif.c b/test/c/std/gif.c index 0f3b9db6..fee7240c 100644 --- a/test/c/std/gif.c +++ b/test/c/std/gif.c @@ -3,7 +3,11 @@ /* This test program is typically run indirectly, by the "puffs test" or "puffs -bench" commands. To manually run it: +bench" commands. These commands take an optional "-mimic" flag to check that +Puffs' output mimics (i.e. exactly matches) other libraries' output, such as +giflib for GIF, libpng for PNG, etc. + +To manually run this test: for cc in clang gcc; do $cc -std=c99 -Wall -Werror gif.c && ./a.out @@ -13,12 +17,11 @@ done Each edition should print "PASS", amongst other information, and exit(0). Add the "puffs mimic cflags" (everything after the colon below) to the C -compiler flags (after the .c file) to test that Puffs' output matches other -libraries' output. +compiler flags (after the .c file) to run the mimic tests. To manually run the benchmarks, replace "-Wall -Werror" with "-O3" and replace "./a.out" with "./a.out -bench". Combine these changes with the "puffs mimic -cflags" to run the mimic benchmarks in addition to the Puffs benchmarks. +cflags" to run the mimic benchmarks. */ // !! puffs mimic cflags: -DPUFFS_MIMIC -lgif