Improving font packages: Difference between revisions

Latest revision as of 12:42, 23 March 2011

Fedora includes a large selection of font packages. Unfortunately, due to lack of strong font release conventions, variable packager experience, commitment or attention to detail, uneven package complexity^[1], they're not all to the same quality standard.

This page will help you improve our font package quality pool by specifying ways you can help enhance existing packages, and ways you can tune new packages during creation.

Language checks

To give users more flexibility, especially in an automatic font installation context, we require fine-grained font packages.

Unfortunately that also increases the number of summaries and descriptions font packagers need to write, and upstreams do not always provide ready-to-use text snippets^[2]. Many packagers would appreciate proposals to improve those:

Summaries

Font summaries need to be short and to the point. Usual informations are font style and Unicode coverage. Only repeat the font name(s) if you don't have anything else to write.

Descriptions

Font descriptions must detail information on the font style, Unicode coverage, and intended use^[3] to help users choose the right packages to install. Also, it is considered good form to credit the original font designer and sum up the font history.

Incidentally, this is a good way to check if the licensing information declared by upstream is correct and if some fontconfig substitution rules can be added to the package.

Examples of terrific font descriptions are found on the Greek Font Society web site. This is what other font packages should strive to emulate.

Naming

We have strict naming rules that all font packages should follow. Please check they're respected.

Technical tests

Manual checks

spec files

Check out the files the packager used, compare them to the official templates in fontpackages-devel^[4], and report discrepancies which have no justification.

Graphical diff tools such as meld can be especially helpful.

# yum install fontpackages-devel meld
$ meld foo.spec /etc/rpmdevtools/spectemplate-fonts-bar.spec

fontconfig rules

Our fontconfig rules have many origins^[5] and mistakes are common^[6]. To help identify and fix them:

try to find a packageset that works and packageset that does not
compare the output of:
```
fc-match -s :family=<name>:lang=<loc>
```
in both cases, with <name> the font family you requested^[7] and <loc> the target locale^[8].
if necessary, identify more precisely the problem font,
examine the fontconfig rules shipped with the problem package,

 # yum install fontpackages-devel meld
 $ meld foo.conf /usr/share/fontconfig/templates/bar.conf

report your findings.

comps

Check all our font packages are properly declared in the fonts or legacy-fonts comps groups (once they are approved).

Automated tests

Checking the package builds

Make sure the package builds in Mock or (if he's already a packager) in a Koji scratch build

Checking package sanity

Check the resulting packages with rpmlint

# yum install rpmlint
$ rpmlint package1.rpm … packageN.rpm

Checking font specific issues

Check the resulting packages with repo-font-audit:

# yum install fontpackages-tools createrepo
$ mkdir /tmp/testrepo
$ mv package1.rpm … packageN.rpm /tmp/testrepo
$ createrepo /tmp/testrepo
$ repo-font-audit testrepo file:///tmp/testrepo

Checking upgrade paths

(when a set of packages is intended to replace another)

To check an upgrade path works:

find a test Fedora system,
make sure none of the new packages are already installed^[9],
install part or all of the old package set,
copy the new packages to a local directory^[10],
run createrepo on this directory^[11],
point dnf to it^[12],
try a dnf upgrade.
if that fails, try to understand why, rpm -e whatever dnf upgrade installed and repeat from step 1.

You can also use:

rpm -qp --obsoletes mypackage

… to check the obsoletes declared by one of your new packages and,

dnf list obsoletes

before the dnf upgrate to check what dnf thinks about your new packages^[13].

Notes:

↑ Especially if layers of legacy compatibility rules make the spec file hard to read or maintain.
↑ Or they do not provide them in English
↑ Print, screen, headings, code…
↑ Look in /etc/rpmdevtools/.
↑
- default rules provided by fontconfig upstream,
- rules written by Fedora packagers using our own templates: install fontpackages-devel and look in /usr/share/fontconfig/templates/,
- rules written by Fedora packagers without regard for our templates,
- rules written by font projects.
↑
While trying to:
- workaround KDE/QT fontconfig processing bugs,
- make sure one's font is the default for some languages,
- make sure one's font rendering preferences are default for one font,
… it is very easy to change settings for other fonts and create other unrelated problems.
↑ For example sans, serif…
↑ For example ja-jp, zh, etc.
↑ It would confuse the tools.
↑
If you're creating them:
1. adapt the previous spec file or create a new one,
2. mock/koji-build the result.
↑
```
createrepo <directory>
```

↑ Use a repo file such as this one:

[tmp]
name=tmp
baseurl=file:///tmp/rpm
enabled=1
gpgcheck=0

↑ But that won't check scriptlets and other packaging bits so do check dnf upgrade works afterwards.

Fonts in Fedora
The Fonts SIG takes loving care of Fedora fonts. Please join this special interest group if you are interested in creating, improving, packaging, or just suggesting a font. Any help will be appreciated.

[1] Especially if layers of legacy compatibility rules make the spec file hard to read or maintain.

[2] Or they do not provide them in English

[3] Print, screen, headings, code…

[4] Look in /etc/rpmdevtools/.

[5] 
default rules provided by fontconfig upstream,

rules written by Fedora packagers using our own templates: install fontpackages-devel and look in /usr/share/fontconfig/templates/,

rules written by Fedora packagers without regard for our templates,

rules written by font projects.

[6] ult rules provided by fontconfig upstream,

[7] rules written by Fedora packagers using our own templates: install fontpackages-devel and look in /usr/share/fontconfig/templates/,

[8] rules written by Fedora packagers without regard for our templates,

[9] rules written by font projects.

[6] While trying to:
workaround KDE/QT fontconfig processing bugs,

make sure one's font is the default for some languages,

make sure one's font rendering preferences are default for one font,
… it is very easy to change settings for other fonts and create other unrelated problems.

[11] workaround KDE/QT fontconfig processing bugs,

[12] sure one's font is the default for some languages,

[13] sure one's font rendering preferences are default for one font,

[7] For example sans, serif…

[8] For example ja-jp, zh, etc.

[9] It would confuse the tools.

[10] If you're creating them:
adapt the previous spec file or create a new one,

mock/koji-build the result.

[18] t the previous spec file or create a new one,

[19] /koji-build the result.

[11] 
createrepo <directory>

[12] Use a repo file such as this one:
[tmp] name=tmp baseurl=file:///tmp/rpm enabled=1 gpgcheck=0

[13] But that won't check scriptlets and other packaging bits so do check dnf upgrade works afterwards.

[23] t the previous spec file or create a new one,

[24] /koji-build the result.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

@@ Line 36: / Line 36: @@
 Graphical diff tools such as '''meld''' can be especially helpful.
+ # yum install fontpackages-devel meld
+ $ meld foo.spec /etc/rpmdevtools/spectemplate-fonts-bar.spec
 ==== fontconfig rules ====
@@ Line 43: / Line 46: @@
 ==== comps ====
-Check all our font packages are properly declared in the fonts or legacy-fonts [http://cvs.fedoraproject.org/viewcvs/comps/ comps] [[:Packaging:FontsPolicy#Grouping|groups]] (once they are approved).
+Check all our font packages are properly declared in the fonts or legacy-fonts [http://git.fedorahosted.org/git/comps.git comps] [[:Packaging:FontsPolicy#Grouping|groups]] (once they are approved).
 === Automated tests ===

Search