Home Wiki > openSUSE:KDE Patch Annotation Policy
Sign up | Login

openSUSE:KDE Patch Annotation Policy

tagline: From openSUSE

Patches applied to KDE and Qt packages have to be in proper patch format, which means the filename ends in .patch and they have proper annotations.

Whether a patch is from/for upstream or downstream-only is indicated by the .spec file. The preceding "# PATCH-(FIX|FEATURE)-OPENSUSE" or "# PATCH-(FIX|FEATURE)-UPSTREAM" are the indicator. Such a comment indicates that all following patches are of the same type.

Downstream patches are to be applied after all upstream patches to avoid conflicts. This is part of the .spec file to make sorting and grouping easier.

Patch annotation

Each Patch or diff in KDE and Qt packages needs a comment header, consisting of the following headers. Formatting should be exact, to make scripted analysis possible. Avoid extra whitespace around ':', case should not matter.

 Subject: <one line summary of the patch>

One line summary what the patch does. if more information is needed, it can be put anywhere else in a non-formatted line, as a regular patch comment

 From: Full Name (<email address>, optional)

Who wrote the patch.

 References: boo#123456, kde#1337
 References: fate#123456

Related bug reports, if applicable. For upstream reports, the included BUG/CCBUG lines are sufficient.

If the Subject line is not enough to explain the contents of the patch fully, the header can be followed by an arbitrarily long description.