Gitweb links:
...log
http://git.netsurf-browser.org/libnsgif.git/shortlog/716e0fae9a007e7c3c5d52cfb7354b139f851b6d
...commit
http://git.netsurf-browser.org/libnsgif.git/commit/716e0fae9a007e7c3c5d52cfb7354b139f851b6d
...tree
http://git.netsurf-browser.org/libnsgif.git/tree/716e0fae9a007e7c3c5d52cfb7354b139f851b6d
The branch, master has been updated
via 716e0fae9a007e7c3c5d52cfb7354b139f851b6d (commit)
from 8019292b7adabf81794dddf6bcf126d440ab229f (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commitdiff
http://git.netsurf-browser.org/libnsgif.git/commit/?id=716e0fae9a007e7c3c5d52cfb7354b139f851b6d
commit 716e0fae9a007e7c3c5d52cfb7354b139f851b6d
Author: Michael Drake <t...@netsurf-browser.org>
Commit: Michael Drake <t...@netsurf-browser.org>
Docs: Update README to mention nsgif_data_scan errors.
diff --git a/README.md b/README.md
index cb380c3..63ccdc7 100644
--- a/README.md
+++ b/README.md
@@ -49,10 +49,15 @@ Now you can load the GIF source data into the nsgif object
with
This scans the source data and decodes information about each frame, however
it doesn't decode any of the bitmap data for the frames. The client may call
-`nsgif_data_scan()` multiple times as source data is fetched. Once the
-function has returned `NSGIF_OK` it has enough data to display at least one
-frame. The early frames can be decoded before the later frames are scanned.
-Frames have to be scanned before they can be decoded.
+`nsgif_data_scan()` multiple times as source data is fetched. The early frames
+can be decoded before the later frames are scanned. Frames have to be scanned
+before they can be decoded.
+
+This function will sometimes return an error. That is OK, and even expected.
+It is fine to proceed to decoding any frames that are available after a scan.
+Some errors indicate that there is a flaw in the source GIF data (not at all
+uncommon, GIF is an ancient format that has had many broken encoders), or that
+it has reached the end of the source data.
> **Note**: The client must not free the data until after calling
> `nsgif_destroy()`. You can move the data, e.g. if you realloc to a bigger
-----------------------------------------------------------------------
Summary of changes:
README.md | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index cb380c3..63ccdc7 100644
--- a/README.md
+++ b/README.md
@@ -49,10 +49,15 @@ Now you can load the GIF source data into the nsgif object
with
This scans the source data and decodes information about each frame, however
it doesn't decode any of the bitmap data for the frames. The client may call
-`nsgif_data_scan()` multiple times as source data is fetched. Once the
-function has returned `NSGIF_OK` it has enough data to display at least one
-frame. The early frames can be decoded before the later frames are scanned.
-Frames have to be scanned before they can be decoded.
+`nsgif_data_scan()` multiple times as source data is fetched. The early frames
+can be decoded before the later frames are scanned. Frames have to be scanned
+before they can be decoded.
+
+This function will sometimes return an error. That is OK, and even expected.
+It is fine to proceed to decoding any frames that are available after a scan.
+Some errors indicate that there is a flaw in the source GIF data (not at all
+uncommon, GIF is an ancient format that has had many broken encoders), or that
+it has reached the end of the source data.
> **Note**: The client must not free the data until after calling
> `nsgif_destroy()`. You can move the data, e.g. if you realloc to a bigger
--
NetSurf GIF Decoder
_______________________________________________
netsurf-commits mailing list -- netsurf-commits@netsurf-browser.org
To unsubscribe send an email to netsurf-commits-le...@netsurf-browser.org
