From 414a011491ff513b86d8694c5d71800f3cb5a715 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Fri, 22 Jan 2021 13:23:54 +1100 Subject: [PATCH] Add doc/note for WUFFS_BASE__QUIRK_IGNORE_CHECKSUM --- doc/note/quirks.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/note/quirks.md b/doc/note/quirks.md index fdeb021b..b1c1302a 100644 --- a/doc/note/quirks.md +++ b/doc/note/quirks.md @@ -48,5 +48,16 @@ values, such as `WUFFS_JSON__QUIRK_ALLOW_LEADING_UNICODE_BYTE_ORDER_MARK`. ## Listing +Common quirks: + +- `WUFFS_BASE__QUIRK_IGNORE_CHECKSUM` configures decoders (but not encoders) to + skip checksum verification. This can result in [noticably faster + decodes](https://github.com/google/wuffs/commit/170a8104867fa818d329d85921012c922577c955), + at a cost of being less able to detect data corruption and to deviate from a + strict reading of the relevant file format specifications, accepting some + inputs that are technically invalid (but otherwise decode fine). + +Package-specific quirks: + - [GIF image decoder quirks](/std/gif/decode_quirks.wuffs) - [JSON decoder quirks](/std/json/decode_quirks.wuffs)