Add warning about possible concurrent tile race #1151

lovell · May 25, 2018 · ddc2349 · ddc2349
1 parent 54a71fc
commit ddc2349
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/api-output.md b/docs/api-output.md
@@ -279,6 +279,8 @@ Use tile-based deep zoom (image pyramid) output.
 Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
 Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
 
+Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
+
 **Parameters**
 
 -   `tile` **[Object][15]?** 

diff --git a/lib/output.js b/lib/output.js
@@ -390,6 +390,8 @@ function toFormat (format, options) {
  * Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
  * Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
  *
+ * Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
+ *
  * @example
  *  sharp('input.tiff')
  *   .png()