From 5e4ed8ba2b4974b0093212c8aecd76cf4ae86088 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Sat, 16 Jan 2021 15:45:13 +0100 Subject: [PATCH] Documentation update for repository move to 'freedesktop.org'. --- builds/atari/README.TXT | 4 +- builds/windows/vc2010/freetype.vcxproj | 2 +- docs/CHANGES | 12 +++++ docs/INSTALL.ANY | 12 ++--- docs/release | 71 +++++++++++++------------- 5 files changed, 57 insertions(+), 44 deletions(-) diff --git a/builds/atari/README.TXT b/builds/atari/README.TXT index ffe65456d..1300817b2 100644 --- a/builds/atari/README.TXT +++ b/builds/atari/README.TXT @@ -15,7 +15,7 @@ To compile FreeType 2 as a library the following changes must be applied: INCLUDE;E:\freetype2\include -- The file `freetype2/include/Ft2build.h' must be patched as follows to +- The file `freetype/include/Ft2build.h' must be patched as follows to include ATARI.H: #ifndef FT2_BUILD_GENERIC_H_ @@ -40,7 +40,7 @@ ge INCLUDE;E:\freetype2\include -- In der Datei freetype2/include/Ft2build.h muss zu Beginn +- In der Datei freetype/include/Ft2build.h muss zu Beginn ein #include "ATARI.H" wie folgt eingefgt werden: #ifndef FT2_BUILD_GENERIC_H_ diff --git a/builds/windows/vc2010/freetype.vcxproj b/builds/windows/vc2010/freetype.vcxproj index b259c682e..209e3ede5 100644 --- a/builds/windows/vc2010/freetype.vcxproj +++ b/builds/windows/vc2010/freetype.vcxproj @@ -364,6 +364,6 @@ - + diff --git a/docs/CHANGES b/docs/CHANGES index 8f193f8d4..165593274 100644 --- a/docs/CHANGES +++ b/docs/CHANGES @@ -60,6 +60,18 @@ CHANGES BETWEEN 2.10.4 and 2.11.0 This work was Priyesh Kumar's GSoC 2020 project. + - FreeType has moved its infrastructure to + + https://gitlab.freedesktop.org/freetype + + A side effect is that the git repositories are now called + `freetype.git` and `freetype-demos.git`, which by default expand + to the directories `freetype` and `freetype-demos`, respectively. + The documentation has been updated accordingly. + + FreeType's Savannah repositories will stay; they are now mirrors + of the 'freedesktop.org' repositories. + ====================================================================== diff --git a/docs/INSTALL.ANY b/docs/INSTALL.ANY index 879dddb89..ecfa6093d 100644 --- a/docs/INSTALL.ANY +++ b/docs/INSTALL.ANY @@ -21,9 +21,9 @@ I. Standard procedure * You need to add the directory `include' to your include path when compiling the library. - * FreeType 2 is made of several components; each of them is located - in a subdirectory of `freetype2/src'. For example, - `freetype2/src/truetype/' contains the TrueType font driver. + * FreeType 2 is made of several components; each of them is located + in a subdirectory of `freetype/src'. For example, + `freetype/src/truetype/' contains the TrueType font driver. * DO NOT COMPILE ALL C FILES! Rather, compile the following ones. @@ -125,9 +125,9 @@ II. Support for flat-directory compilation 1. Copy all files in current directory - cp freetype2/src/base/*.[hc] . - cp freetype2/src/raster1/*.[hc] . - cp freetype2/src/smooth/*.[hc] . + cp freetype/src/base/*.[hc] . + cp freetype/src/raster1/*.[hc] . + cp freetype/src/smooth/*.[hc] . etc. 2. Compile sources diff --git a/docs/release b/docs/release index 628dded2c..01cc57656 100644 --- a/docs/release +++ b/docs/release @@ -1,26 +1,26 @@ How to prepare a new release ---------------------------- -. include/freetype/freetype.h: Update FREETYPE_MAJOR, FREETYPE_MINOR, - and FREETYPE_PATCH. +. include/freetype/freetype.h: Update `FREETYPE_MAJOR`, + `FREETYPE_MINOR`, and `FREETYPE_PATCH`. . Update version numbers in all files where necessary (for example, do - a grep for both `2.3.1' and `231' for release 2.3.1). + a grep for both '2.10.4' and '2104' for release 2.10.4). -. builds/unix/configure.raw: Update `version_info'. +. builds/unix/configure.raw: Update `version_info`. . docs/CHANGES: Document differences to last release. . README: Update. -. docs/VERSIONS.TXT: Document changed `version_info'. +. docs/VERSIONS.TXT: Document changed `version_info`. -. ChangeLog: Announce new release (both in the freetype2 and - freetype2-demos modules). +. ChangeLog: Announce new release (both in the 'freetype' and + 'freetype-demos' repositories). . Clone the git archive to another directory with - git clone -l -s . ../freetype2.test + git clone -l -s . ../freetype.test or something like this and run @@ -35,14 +35,14 @@ How to prepare a new release in the cloned repository to test compilation with both gcc and g++. -. Test C++ compilation for freetype2-demos too (using `git clone' as +. Test C++ compilation for 'freetype-demos' too (using `git clone` as above). -. Run src/tools/chktrcmp.py and check that there are no undefined - trace_XXXX macros. +. Run `src/tools/chktrcmp.py` and check that there are no undefined + `trace_XXXX` macros. -. After pushing the new release, tag the git repositories (freetype2, - freetype2-demos) with +. After pushing the new release, tag the git repositories ('freetype', + 'freetype-demos') with git tag VER- -m "" -u @@ -54,29 +54,29 @@ How to prepare a new release git clean -ndx - that the git directory is really clean (and remove extraneous files + that the git directory is really clean (and remove extraneous files if necessary). -. Say `make dist' in both the freetype2 and freetype2-demos modules - to generate the .tar.gz, .tar.xz, and .zip files. +. Say `make dist` in both the 'freetype' and 'freetype-demos' + repositories to generate the `.tar.gz`, `.tar.xz`, and `.zip` files. -. Create the doc bundles (freetype-doc-.tar.gz, - freetype-doc-.tar.xz, ftdoc.zip). This is +. Create the doc bundles (`freetype-doc-.tar.gz`, + `freetype-doc-.tar.xz`, `ftdoc.zip`). This is everything in /freetype2/docs - except the `reference' subdirectory. Do *not* use option `-l' from + except the `reference` subdirectory. Do *not* use option `-l` from zip! -. Run the following script (with updated `$VERSION', `$SAVANNAH_USER', - and $SOURCEFORGE_USER variables) to sign and upload the bundles to +. Run the following script (with updated `$VERSION`, `$SAVANNAH_USER`, + and `$SOURCEFORGE_USER` variables) to sign and upload the bundles to both Savannah and SourceForge. The signing code has been taken from - the `gnupload' script (part of the automake bundle). + the `gnupload` script (part of the 'automake' bundle). #!/bin/sh - VERSION=2.5.1 + VERSION=2.10.4 SAVANNAH_USER=wl SOURCEFORGE_USER=wlemb @@ -155,12 +155,13 @@ How to prepare a new release # EOF -. Prepare a README for SourceForge and upload it with the following - script (with updated `$VERSION' and $SOURCEFORGE_USER variables). +. Prepare a `README` file for SourceForge and upload it with the + following script (with updated `$VERSION` and `$SOURCEFORGE_USER` + variables). #!/bin/sh - VERSION=2.5.1 + VERSION=2.10.4 SOURCEFORGE_USER=wlemb ##################################################################### @@ -170,22 +171,22 @@ How to prepare a new release # EOF -. On SourceForge, tag the just uploaded `ftXXX.zip' and - `freetype-XXX.tar.xz' files as the default files to download for - `Windows' and `Others', respectively. +. On SourceForge, tag the just uploaded `ftXXX.zip` and + `freetype-XXX.tar.xz` files as the default files to download for + 'Windows' and 'Others', respectively. -. Copy the reference files (generated by `make dist') to +. Copy the reference files (generated by `make dist`) to /freetype2/docs/reference -. Update the `freetype-web' repository. `git push' then automatically - triggers an update of the public web pages within ten minutes, due - to a cron script (on wl@freedesktop.org) that rsyncs with +. Update the 'freetype-web' repository. `git push` then automatically + triggers an update of the public web pages within ten minutes due to + a cron script (on 'wl@freedesktop.org') that rsyncs with freedesktop.org://srv/freetype.freedesktop.org/www -. Announce new release on freetype-announce@nongnu.org and to relevant - newsgroups. +. Announce new release on 'freetype-announce@nongnu.org' and to + relevant newsgroups. ----------------------------------------------------------------------