From Fedora Project Wiki
m (1 revision(s))
(manually merge lost comments from wikiold lost during the moinmoin -> mediawiki transition. wiki team is aware of the issue, but does not seem to care...)
Line 2: Line 2:


All patches in Fedora spec files '''SHOULD''' have a comment above them about their upstream status.  Any time you create a patch, it is best practice to file it in an upstream bug tracker, and include a link to that in the comment above the patch.  For example:
All patches in Fedora spec files '''SHOULD''' have a comment above them about their upstream status.  Any time you create a patch, it is best practice to file it in an upstream bug tracker, and include a link to that in the comment above the patch.  For example:
<pre>
<pre>
# http://bugzilla.gnome.org/show_bug.cgi?id=12345
Patch0: gnome-panel-fix-frobnicator.patch
Patch0: gnome-panel-fix-frobnicator.patch
</pre>
</pre>
Line 9: Line 11:


<pre>
<pre>
# Don't crash with frobnicator applet
# http://bugzilla.gnome.org/show_bug.cgi?id=12345
Patch0: gnome-panel-fix-frobnicator.patch
Patch0: gnome-panel-fix-frobnicator.patch
</pre>
</pre>
Line 18: Line 22:


<pre>
<pre>
# Sent upstream via email 20080407
Patch0: foobar-fix-the-bar.patch
Patch0: foobar-fix-the-bar.patch
</pre>
</pre>


<pre>
<pre>
# Upstream has applied this in SVN trunk
Patch0: foobar-fix-the-baz.patch
Patch0: foobar-fix-the-baz.patch
</pre>
</pre>
Line 29: Line 36:


<pre>
<pre>
# This patch is temporary until we land the long term System.loadLibrary fix in OpenJDK
Patch0: jna-jni-path.patch
Patch0: jna-jni-path.patch
</pre>
</pre>

Revision as of 07:29, 13 June 2008

All patches should have an upstream bug link or comment

All patches in Fedora spec files SHOULD have a comment above them about their upstream status. Any time you create a patch, it is best practice to file it in an upstream bug tracker, and include a link to that in the comment above the patch. For example:

# http://bugzilla.gnome.org/show_bug.cgi?id=12345
Patch0: gnome-panel-fix-frobnicator.patch

The above is perfectly acceptable; but if you prefer, a brief comment about what the patch does above can be helpful:

# Don't crash with frobnicator applet
# http://bugzilla.gnome.org/show_bug.cgi?id=12345
Patch0: gnome-panel-fix-frobnicator.patch

Sending patches upstream and adding this comment will help ensure that Fedora is acting as a good FLOSS citizen (see Why Upstream? ). It will help others (and even you) down the line in package maintenance by knowing what patches are likely to appear in a new upstream release.

If upstream doesn't have a bug tracker

You can indicate that you have sent the patch upstream and any known status:

# Sent upstream via email 20080407
Patch0: foobar-fix-the-bar.patch


# Upstream has applied this in SVN trunk
Patch0: foobar-fix-the-baz.patch

Fedora-specific (or rejected upstream) patches

It may be that some patches truly are Fedora-specific; in that case, say so:

# This patch is temporary until we land the long term System.loadLibrary fix in OpenJDK
Patch0: jna-jni-path.patch

Why upstream?

Refer Why Upstream?