Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: NixOS/nixpkgs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: ba710d964f07
Choose a base ref
...
head repository: NixOS/nixpkgs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 5bc2da9f4229
Choose a head ref
  • 2 commits
  • 1 file changed
  • 2 contributors

Commits on Apr 26, 2020

  1. Update commit policy for stable release branches 

    only very few people followed the strict policy in the last 5 years. the
maintainers accept backports without reason when it's obvious, so i
updated the policy to reflect that

(cherry picked from commit bcc269e)
    @davidak
    davidak committed Apr 26, 2020

    Verified

    This commit was signed with the committer’s verified signature.
    ljharb Jordan Harband
    GPG key ID: 9F6A681E35EF8B56
    Verified
    Learn about vigilant mode
    Copy the full SHA
    57e2dcb View commit details

  2. Merge pull request #86066 from davidak/backport-commit-policy 

    [20.03] Update commit policy for stable release branches
    @worldofpeace
    worldofpeace authored Apr 26, 2020

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    GPG key ID: B5690EEEBB952194
    Verified
    Learn about vigilant mode
    Copy the full SHA
    5bc2da9 View commit details
Showing with 36 additions and 12 deletions.
  1. +36 −12 doc/contributing/submitting-changes.xml
48 changes: 36 additions & 12 deletions doc/contributing/submitting-changes.xml
View file
Original file line number Diff line number Diff line change
@@ -407,23 +407,47 @@ Additional information.
<section xml:id="submitting-changes-stable-release-branches">
<title>Stable release branches</title>

<itemizedlist>
<para>
For cherry-picking a commit to a stable release branch (<quote>backporting</quote>), use <literal>git cherry-pick -x &lt;original commit&gt;</literal> so that the original commit id is included in the commit.
</para>

<para>
Add a reason for the backport by using <literal>git cherry-pick -xe &lt;original commit&gt;</literal> instead when it is not obvious from the original commit message. It is not needed when it’s a minor version update that includes security and bug fixes but don’t add new features or when the commit fixes an otherwise broken package.
</para>

<para>
Here is an example of a cherry-picked commit message with good reason description:
</para>

<screen>
zfs: Keep trying root import until it works

Works around #11003.

(cherry picked from commit 98b213a11041af39b39473906b595290e2a4e2f9)

Reason: several people cannot boot with ZFS on NVMe
</screen>

<para>
Other examples of reasons are:
</para>

<itemizedlist spacing="compact">
<listitem>
<para>
If you're cherry-picking a commit to a stable release branch (“backporting”), always use <command>git cherry-pick -xe</command> and ensure the message contains a clear description about why this needs to be included in the stable branch.
Previously the build would fail due to, e.g., <literal>getaddrinfo</literal> not being defined
</para>
</listitem>
<listitem>
<para>
An example of a cherry-picked commit would look like this:
The previous download links were all broken
</para>
</listitem>
<listitem>
<para>
Crash when starting on some X11 systems
</para>
<screen>
nixos: Refactor the world.

The original commit message describing the reason why the world was torn apart.

(cherry picked from commit abcdef)
Reason: I just had a gut feeling that this would also be wanted by people from
the stone age.
</screen>
</listitem>
</itemizedlist>
</section>