diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt index cc98e874e..9f72c708a 100644 --- a/docs/.custom_wordlist.txt +++ b/docs/.custom_wordlist.txt @@ -13,6 +13,7 @@ autosync backgrounding backport backported +backporter Backporters backporting backtrace diff --git a/docs/contributors/uploading/backport-a-package.md b/docs/contributors/uploading/backport-a-package.md new file mode 100644 index 000000000..09671f7b5 --- /dev/null +++ b/docs/contributors/uploading/backport-a-package.md @@ -0,0 +1,86 @@ +(how-to-backport-a-package)= +# How to backport a package + +Backporting makes new functionality available in a stable Ubuntu release. Unlike the {ref}`SRU process `, which only applies to bug fixes, backports can introduce new features. + +For an overview of what backports are, see {ref}`backports`. + +:::{admonition} **Sponsorship** series +The article series provides guidance on requesting sponsorship and sponsoring. + +Overview: +: * {ref}`sponsorship` + +For contributors: +: * {ref}`how-to-find-a-sponsor` + * {ref}`how-to-request-an-upload` + * {ref}`how-to-request-a-sync` + * {ref}`how-to-backport-a-package` (this article) + +For sponsors: +: * {ref}`how-to-review-a-merge-proposal` + * {ref}`how-to-sponsor-an-upload` + * {ref}`how-to-sponsor-a-sync` +::: + + +## Requesting a backport + +File a bug against the package you want to backport, subscribe the `ubuntu-backporters` team, and summarize the key fixes or features that justify the backport. Unlike an SRU, you do not need to list every fixed bug — a summary of the main reasons is sufficient. + +Backports are intended for new features, not for bug fixes that could go through the SRU process. If the only motivation is a bug fix, use the SRU process instead. + + +## Rules + +* Some packages are forbidden from backporting (see below). +* Backports to non-LTS releases are not accepted, with specific exceptions. +* Backports should come from: + * The current Ubuntu stable release (preferred), or + * The current LTS release, targeting the prior LTS release, or + * The current package version in the Ubuntu development release. +* Users must be able to upgrade from LTS to LTS. Backported packages must not break the upgrade path between releases. + +### Forbidden packages + +Some packages are handled exclusively by the Ubuntu Backports Team and cannot be backported by contributors. For the current list, check with the team in the tracking bug or on the [ubuntu-backporters mailing list](https://lists.ubuntu.com/mailman/listinfo/ubuntu-backporters). + + +## Preparing the backport + +Prepare the backported package and make it available for review. You can: + +* Provide a `debdiff` against the version you are backporting from. +* Link to a PPA where you have a backported build prepared. + +The format is up to your sponsor — ask them what they prefer. + +For a refresher on building packages locally, see {ref}`how-to-build-packages-locally`. + + +## Review and upload + +Once you have prepared the backport, request a sponsor to review and upload it. Follow the standard {ref}`sponsorship ` process. + +The sponsor will review the package for: + +* Correctness of the backport (no unnecessary changes). +* Compatibility with the target release. +* No regressions introduced. + + +## Responsibilities + +As the backporter, you are responsible for: + +* Monitoring the backported package for bug reports, security patches, and additional updates that should be backported. +* Any backport-specific bugs that were not present in the original version. + + +## See also + +* {ref}`backports` +* {ref}`stable-release-updates` +* {ref}`how-to-upload-packages-to-a-ppa` +* [Ubuntu Backports user documentation](https://help.ubuntu.com/community/UbuntuBackports) +* [Ubuntu Backports team policies](https://wiki.ubuntu.com/UbuntuBackports/Policies) diff --git a/docs/contributors/uploading/find-a-sponsor.md b/docs/contributors/uploading/find-a-sponsor.md index c076db79a..4bcbe3587 100644 --- a/docs/contributors/uploading/find-a-sponsor.md +++ b/docs/contributors/uploading/find-a-sponsor.md @@ -18,6 +18,7 @@ For contributors: : * {ref}`how-to-find-a-sponsor` (this article) * {ref}`how-to-request-an-upload` * {ref}`how-to-request-a-sync` + * {ref}`how-to-backport-a-package` For sponsors: : * {ref}`how-to-review-a-merge-proposal` diff --git a/docs/contributors/uploading/index.md b/docs/contributors/uploading/index.md index 364a883b7..ce84b2727 100644 --- a/docs/contributors/uploading/index.md +++ b/docs/contributors/uploading/index.md @@ -11,6 +11,7 @@ Packages are [uploaded via FTP](ftp://upload.ubuntu.com/) using {ref}`dput or du Find a sponsor Request an upload Request a sync +Backport a package ``` ## Further reading diff --git a/docs/contributors/uploading/request-a-sync.md b/docs/contributors/uploading/request-a-sync.md index 221de8294..0a8f195c5 100644 --- a/docs/contributors/uploading/request-a-sync.md +++ b/docs/contributors/uploading/request-a-sync.md @@ -13,6 +13,7 @@ For contributors: : * {ref}`how-to-find-a-sponsor` * {ref}`how-to-request-an-upload` * {ref}`how-to-request-a-sync` (this article) + * {ref}`how-to-backport-a-package` For sponsors: : * {ref}`how-to-review-a-merge-proposal` diff --git a/docs/contributors/uploading/request-an-upload.md b/docs/contributors/uploading/request-an-upload.md index 6d691c3ab..efebe2f65 100644 --- a/docs/contributors/uploading/request-an-upload.md +++ b/docs/contributors/uploading/request-an-upload.md @@ -13,6 +13,7 @@ For contributors: : * {ref}`how-to-find-a-sponsor` * {ref}`how-to-request-an-upload` (this article) * {ref}`how-to-request-a-sync` + * {ref}`how-to-backport-a-package` For sponsors: : * {ref}`how-to-review-a-merge-proposal` diff --git a/docs/how-ubuntu-is-made/processes/backports.rst b/docs/how-ubuntu-is-made/processes/backports.rst index e6ca709cc..b87d73932 100644 --- a/docs/how-ubuntu-is-made/processes/backports.rst +++ b/docs/how-ubuntu-is-made/processes/backports.rst @@ -6,7 +6,7 @@ Backports Backporting allows for making new functionality (that is not connected to a critical bug fix) available in a stable release. For these scenarios, there are two options: * :ref:`Uploading to a PPA `. -* Preparing a backport. +* :ref:`Preparing a backport `. Official Ubuntu Backports