From c5f74d681f3aa02c1cec235e51328b2a71302752 Mon Sep 17 00:00:00 2001 From: Ben Harris Date: Mon, 23 Dec 2024 14:25:42 +0000 Subject: [PATCH] Add a comment explaining what compatcheck does --- compatcheck | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/compatcheck b/compatcheck index a11478f..fc86ac1 100755 --- a/compatcheck +++ b/compatcheck @@ -2,6 +2,24 @@ # SPDX-License-Identifier: CC0-1.0 +# This is a script to check the backward compatibility of fonts, and +# specifically of Bedstead. It takes two font files as arguments and +# checks whether upgrades from the first to the second will break +# anything. It should fail on anything that would require a change of +# major version number. +# +# Things that are checked: +# +# Glyph names. Existing PostScript files that refer to specific glyph +# names should continue to work. The script checks that all glyph +# names in the old font still exist, but not that they look right. +# +# Code points. Anything using a font through the 'cmap' table should +# continue to work. That means that any 'cmap' that exists should +# continue to exist, and that any mapping through any 'cmap' should +# continue to work. As with glyph names, the script checks for the +# existence of mappings, but not their content. + from argparse import ArgumentParser from fontTools import ttLib from sys import exit -- 2.30.2