From 7543f394f77532043c7eeb7f1e028c66da0e4ae6 Mon Sep 17 00:00:00 2001 From: David Turner Date: Mon, 1 Sep 2003 21:18:03 +0000 Subject: [PATCH] updating documentation to warn about potential binary compatibility problems --- README | 28 ++++++++++++++++++++++++++++ docs/CHANGES | 45 ++++++++++++++++++++++++++++++++------------- 2 files changed, 60 insertions(+), 13 deletions(-) diff --git a/README b/README index b1a4e0679..c59627ff8 100644 --- a/README +++ b/README @@ -1,3 +1,31 @@ +===================================================================== +IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT + + During development that followed the 2.1.4 release, some + unfortunate changes to the source code did break *binary* + compatibility of the library with previous releases. This had the + potential to severely break any system where a version of FreeType + was installed from recent CVS sources. + + We did undo the changes, and everything should be completely + compatible now. However, due to other subtleties too long to be + explained here, there may still be a tiny risk that the current + sources break some rare applications. + + This package is thus FreeType 2.1.5 release candidate 1 and has + been released for testing. If you install it on your system, please + be certain to be able to install a previous version in the case + where something would go wrong. + + We will make the official 2.1.5 release as soon as we're convinced + that it will not break anything. + + +IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT +===================================================================== + + + Special notes to Unix users =========================== diff --git a/docs/CHANGES b/docs/CHANGES index 4d0d218c7..01d12296a 100644 --- a/docs/CHANGES +++ b/docs/CHANGES @@ -1,3 +1,30 @@ +===================================================================== +IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT + + During development that followed the 2.1.4 release, some + unfortunate changes to the source code did break *binary* + compatibility of the library with previous releases. This had the + potential to severely break any system where a version of FreeType + was installed from recent CVS sources. + + We did undo the changes, and everything should be completely + compatible now. However, due to other subtleties too long to be + explained here, there may still be a tiny risk that the current + sources break some rare applications. + + This package is thus FreeType 2.1.5 release candidate 1 and has + been released for testing. If you install it on your system, please + be certain to be able to install a previous version in the case + where something would go wrong. + + We will make the official 2.1.5 release as soon as we're convinced + that it will not break anything. + + +IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT +===================================================================== + + LATEST CHANGES BETWEEN 2.1.5 and 2.1.4 @@ -6,7 +33,7 @@ LATEST CHANGES BETWEEN 2.1.5 and 2.1.4 - Parsing the /CIDFontName field now removes the leading slash to be in sync with other font drivers. - - gzip support was buggy. + - gzip support was buggy. Some fonts could not be read. - Fonts which have nested subglyphs more than one level deep no longer cause a segfault. @@ -18,7 +45,8 @@ LATEST CHANGES BETWEEN 2.1.5 and 2.1.4 overwritten. - The font matrix wasn't applied to the advance width for Type1, CID, - and CFF fonts. + and CFF fonts. This caused problem when loading certain synthetic + Type 1 fonts like "Helvetica Narrow" - The test for the charset registry in BDF and PCF fonts is now case-insensitive. @@ -40,8 +68,6 @@ LATEST CHANGES BETWEEN 2.1.5 and 2.1.4 II. IMPORTANT CHANGES - - Unpatented hinting (see below) XXX - - Accessing bitmap font formats has been synchronized. To do that the FT_Bitmap_Size structure has been extended to contain new fields `size', `x_ppem', and `y_ppem'. @@ -74,19 +100,12 @@ LATEST CHANGES BETWEEN 2.1.5 and 2.1.4 - The autohinter has been further improved; for example, `m' glyphs now retain its vertical symmetry. - - Added the optional unpatented hinting system for TrueType. It - allows typefaces which need hinting to produce correct glyph forms - (e.g., Chinese typefaces from Dynalab) to work acceptably without - infringing Apple patents. This system is compiled only if - TT_CONFIG_OPTION_COMPILE_UNPATENTED_HINTING is defined in - ftoption.h. - - Partial support of Mac fonts on non-Mac platforms. - `make refdoc' (after first `make') builds the HTML documentation. You need Python for this. - - The make build system should now work more reliable on DOS-like + - The make build system should now work more reliably on DOS-like platforms. - Support for EMX gcc and Watson C/C++ compilers on MS-DOS has been @@ -192,7 +211,7 @@ LATEST CHANGES BETWEEN 2.1.4 and 2.1.3 with FreeType (i.e., comparing release/libtool/so numbers, and how to use them in autoconf scripts). - - The installation documentation has been seriously revamped. + - The installation documentation has been seriously revamped. Everything is now in the "docs" directory.