From: Nathan Moinvaziri Date: Mon, 21 Mar 2022 18:58:07 +0000 (-0700) Subject: Update language around ABI compatibility with zlib. #1081 X-Git-Tag: 2.1.0-beta1~311 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=523dfefc60c261bf0b8b73ab85116b5a3bc1bd29;p=thirdparty%2Fzlib-ng.git Update language around ABI compatibility with zlib. #1081 --- diff --git a/PORTING.md b/PORTING.md index eda2608d..1f2c7d62 100644 --- a/PORTING.md +++ b/PORTING.md @@ -9,11 +9,19 @@ zlib-compat mode Zlib-ng can be compiled in zlib-compat mode, suitable for zlib-replacement in a single application or system-wide. -Please note that zlib-ng in zlib-compat mode is API-compatible but not -ABI-compatible, meaning that you cannot simply replace the zlib library/dll -files and expect the application to work. The application will need to be +Please note that zlib-ng in zlib-compat mode tries to maintain both API and +ABI compatibility with the original zlib. Any issues regarding compatibility +can be reported as bugs. + +In certain instances you may not be able to simply replace the zlib library/dll +files and expect the application to work. The application may need to be recompiled against the zlib-ng headers and libs to ensure full compatibility. +It is also possible for the deflate output stream to differ from the original +zlib due to algorithmic differences between the two libraries. Any tests or +applications that depend on the exact length of the deflate stream being a +certain value will need to be updated. + **Advantages:** - Easy to port to, since it only requires a recompile of the application and no changes to the application code.