Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/contributors/bug-fix/get-a-new-upstream-version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To download the source for the current version of the source package from the up

.. note::

The ``--download-version`` and ``--download-current-version`` flags are both a :term:`best-effort` features of :manpage:`uscan(1)`.
The ``--download-version`` and ``--download-current-version`` flags are both best-effort features of :manpage:`uscan(1)`.

There are special cases where they do not work for technical reasons.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributors/bug-fix/propose-changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Once you're assigned to the bug, get the source code for the affected package. Y
- ``apt-get source``
- ``dget``

For detailed instructions on using these methods to get the source code, see :ref:`get-package-source`.
For detailed instructions on using these methods to get the source code, see :ref:`how-to-get-the-source-of-a-package`.

Create a patch to fix the issue
-------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
DEP 3 - patch file headers
==========================

This article lists and briefly explains standard fields of the `Debian Enhancement Proposal 3 Specification (DEP-3) -- Patch Tagging Guidelines <DEP3Spec_>`_ for ``.patch`` file headers and also shows :ref:`SampleDEP3CompliantHeaders`.
This article lists and briefly explains standard fields of the `Debian Enhancement Proposal 3 Specification (DEP-3) -- Patch Tagging Guidelines <DEP3Spec_>`_ for ``.patch`` file headers and also shows :ref:`sample-dep-3-compliant-headers`.

Standard fields
---------------
Expand Down
55 changes: 27 additions & 28 deletions docs/how-ubuntu-is-made/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Architecture
application is designed for.

See also:
* [Supported architectures](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/architectures/)
* {ref}`supported-architectures`
* [Computer Architecture (Wikipedia)](https://en.wikipedia.org/wiki/Computer_architecture)

AA
Expand All @@ -94,7 +94,7 @@ Archive Admin
Archive Mirror
A {term}`Mirror` of the {term}`Ubuntu Archive`.

See the section [Mirrors](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivemirrors) for more details.
See the section {ref}`mirrors` for more details.

ARM
*ARM* (formerly an acronym for *Advanced RISC Machines* and originally
Expand Down Expand Up @@ -181,7 +181,7 @@ Binary Package
managing software on a target machine.

See also:
* [Binary Packages (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/package-model/#binarypackages)
* {ref}`Binary Packages (explanation) <binary-packages>`

Blank space
**Blank space** characters refer to characters in a text (especially
Expand Down Expand Up @@ -293,7 +293,7 @@ Changelog
The `debian/changelog` file in a {term}`Source Package`.

See also:
* [Basic overview of the `debian/` directory](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/debian-dir-overview/)
* {ref}`Basic overview of the debian/ directory <debian-directory>`
* [Section 4.4 Debian changelog (Debian Policy Manual v4.6.2.0)](https://www.debian.org/doc/debian-policy/ch-source.html#debian-changelog-debian-changelog)

chroot
Expand Down Expand Up @@ -406,7 +406,7 @@ Control File
or the control file in a {term}`Binary Package` (`.deb` file).

See also:
* [Basic overview of the `debian/` directory](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/debian-dir-overview/)
* {ref}`Basic overview of the debian/ directory <debian-directory>`
* [Chapter 5. Control files and their fields (Debian Policy Manual v4.6.2.0)](https://www.debian.org/doc/debian-policy/ch-controlfields.html)

Coordinated Release Date
Expand All @@ -429,7 +429,7 @@ Copyright File
The `debian/copyright` file in a {term}`Source Package`.

See also:
* [Basic overview of the `debian/` directory](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/debian-dir-overview/)
* {ref}`Basic overview of the debian/ directory <debian-directory>`
* [Section 4.5. Copyright (Debian Policy Manual v4.6.2.0)](https://www.debian.org/doc/debian-policy/ch-source.html#copyright-debian-copyright)

Core Dev
Expand Down Expand Up @@ -551,7 +551,7 @@ Downstream
another software project directly or indirectly.

See also:
* [Downstream (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/upstream-and-downstream/#downstream)
* {ref}`Downstream (explanation) <upstream-and-downstream>`

DSA
Debian System Administration
Expand Down Expand Up @@ -790,7 +790,7 @@ Launchpad
Ubuntu related software projects live.

See also:
* [Launchpad (explanation article)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/launchpad/)
* {ref}`Launchpad (explanation article) <about-launchpad>`

Lintian
{manpage}`lintian(1)` is a Debian package checker. Use it to check binary and source packages for compliance with the Debian policy and for common packaging errors.
Expand Down Expand Up @@ -832,12 +832,12 @@ LXD
* [Official LXD documentation](https://documentation.ubuntu.com/lxd/latest/)

Main
A {term}`Component` of every {term}`Ubuntu` [Series](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archiveseries) in the
A {term}`Component` of every {term}`Ubuntu` {ref}`Series <archive-series>` in the
{term}`Ubuntu Archive` that contains {term}`Open Source <Open Source Software>`
{term}`Packages <Package>` which are supported and maintained by {term}`Canonical`.

See also:
* [Components](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivecomponents)
* {ref}`Components <archive-components>`

Micro-Release Exception
In some cases, when {term}`upstream` fixes {term}`bugs <Bug>`, they do a new
Expand Down Expand Up @@ -915,14 +915,14 @@ Mirror

Multiverse
A {term}`Component` of every {term}`Ubuntu`
[Series](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archiveseries) in the
{ref}`Series <archive-series>` in the
{term}`Ubuntu Archive` that contains {term}`Packages <Package>` of
{term}`Closed Source Software` or {term}`Open Source Software` restricted by
copyright or legal issues. These packages are maintained and supported by
the Ubuntu community.

See also:
* [Components](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivecomponents)
* {ref}`Components <archive-components>`

Namespace
A concept in computer science and software development that defines a scope
Expand Down Expand Up @@ -1031,14 +1031,14 @@ Personal Package Archive
Pocket
A **pocket** is a {term}`Package` sub-{term}`repository <Repository>` within
the Ubuntu Archive. Every Ubuntu {term}`Series` has the following pockets:
* [Release](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets-release)
* [Security](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets-security)
* [Updates](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets-updates)
* [Proposed](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets-proposed)
* [Backports](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets-backports)
* `-release`
* `-security`
* `-updates`
* `-proposed`
* `-backports`

See also:
* [Pockets (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets)
* {ref}Pockets (explanation) <archive-pockets>`

POSIX
Abbreviation for **Portable Operating System Interface**: A family of
Expand Down Expand Up @@ -1140,12 +1140,12 @@ Request of Stable Release Manager
*Work in Progress*

Restricted
A {term}`Component` of every {term}`Ubuntu` [Series](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archiveseries) in the
A {term}`Component` of every {term}`Ubuntu` {ref}`Series <archive-series>` in the
{term}`Ubuntu Archive` that contains {term}`Closed Source <Closed Source Software>`
{term}`Packages <Package>` which are supported and maintained by {term}`Canonical`.

See also:
* [Components](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivecomponents)
* {ref}`Components <archive-components>`

RISC-V
*Work in Progress*
Expand Down Expand Up @@ -1228,7 +1228,7 @@ Source Package
to build one or more {term}`Binary Packages <Binary Package>`.

See also:
* [Source Packages (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/package-model/#sourcepackages)
* {ref}`Source Packages (explanation) <source-packages>`

Source Tree
*Work in Progress*
Expand Down Expand Up @@ -1329,7 +1329,7 @@ Archive
{term}`Source Packages <Source Package>` (`.dsc` files).

See also:
* [Ubuntu Package Archive (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/)
* {ref}`Ubuntu Package Archive (explanation) <package-archive>`

Ubuntu autopkgtest Cloud
*Work in Progress*
Expand Down Expand Up @@ -1517,14 +1517,13 @@ Uniform Resource Locator
* [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)

Universe
A {term}`Component` of every Ubuntu
[Series](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archiveseries)
A {term}`Component` of every Ubuntu {ref}`Series <archive-series>`
in the {term}`Ubuntu Archive` that contains {term}`Open Source <Open Source Software>`
{term}`Packages <Package>` which are supported and maintained by the Ubuntu
community.

See also:
* [Components](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivecomponents)
* {ref}`Components <archive-components>`

Unix
**Unix** is an {term}`Operating System` whose development started in the
Expand All @@ -1548,7 +1547,7 @@ Upstream
A software project (and associated entities), another software project
depends on directly or indirectly.

See [Upstream (explanation)](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/upstream-and-downstream/#upstream)
See {ref}`Upstream (explanation) <upstream-and-downstream>`

UX
User Experience
Expand All @@ -1569,7 +1568,7 @@ User Interface Freeze Exception
*Work in Progress*

See also:
* [Ubuntu development process](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/development-process/)
* {ref}`ui-freeze-exceptions`

VCS
Version Control System
Expand All @@ -1591,7 +1590,7 @@ Watch File
The `debian/watch` file in a {term}`Source Package`.

See also:
* [Basic overview of the `debian/` directory](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/debian-dir-overview/)
* {ref}`Basic overview of the debian/ directory <debian-directory>`
* {manpage}`uscan(1)`
* [Section 4.11. Upstream source location (Debian Policy Manual v4.6.2.0)](https://www.debian.org/doc/debian-policy/ch-source.html#upstream-source-location-debian-watch)

Expand Down
4 changes: 3 additions & 1 deletion docs/how-ubuntu-is-made/concepts/launchpad.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _about-launchpad:

Launchpad
=========

Expand Down Expand Up @@ -31,7 +33,7 @@ Personal Package Archive (PPA)

Launchpad PPA repositories allow you to build installable Ubuntu packages for multiple :term:`architectures <Architecture>` and to host them in your own software :term:`repository <Repository>`.

Using a PPA is straightforward; you don't need the approval of anyone, therefore users have to enable it manually. See how to :ref:`InstallPackagesFromPPA`.
Using a PPA is straightforward; you don't need the approval of anyone, therefore users have to enable it manually. See how to `Install packages from a PPA <https://documentation.ubuntu.com/launchpad/user/how-to/packaging/ppa-install/>`_.

This is useful when you want to test a change, or to show others that a change builds successfully or is installable. Some people have special permission to trigger the :term:`autopkgtests <autopkgtest>` for packages in a PPA.

Expand Down
2 changes: 1 addition & 1 deletion docs/how-ubuntu-is-made/concepts/package-archive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Package archive
===============

:term:`Linux` :term:`distributions <Distribution>` like :term:`Ubuntu` use :ref:`repositories <Repositories>` to hold :term:`packages <Package>` for installing on target machines. Ubuntu has several repositories that anyone can access. The **Ubuntu package archive** hosts :term:`Debian` :term:`binary packages <Binary Package>` (``.deb`` files) and :term:`source packages <Source Package>` (``.dsc`` files).
:term:`Linux` :term:`distributions <Distribution>` like :term:`Ubuntu` use :ref:`repositories <archive-repositories>` to hold :term:`packages <Package>` for installing on target machines. Ubuntu has several repositories that anyone can access. The **Ubuntu package archive** hosts :term:`Debian` :term:`binary packages <Binary Package>` (``.deb`` files) and :term:`source packages <Source Package>` (``.dsc`` files).

On Ubuntu installations, the Ubuntu package archive is configured as the default source for the :term:`APT` package manager to download and install packages from. This Archive splits into many layers, each with its own terminology.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can propose an SRU in the following cases:
- To adjust to changes in the environment, server protocols, or web services. This ensures that Ubuntu remains compatible with evolving technologies.
- For safe cases with low regression potential but high user experience improvement.
- To introduce new features in :term:`LTS releases <LTS>`, usually under strict conditions.
- To update commercial software in the :term:`Canonical partner archive`.
- To update commercial software in the :ref:`partner-archive`.
- To fix :term:`Failed to build from Source` issues.
- To fix :term:`autopkgtest` failures, usually in conjunction with other high-priority fixes.

Expand Down
2 changes: 0 additions & 2 deletions docs/staging/new-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ well.

## Packaging it yourself

You can follow the [Packaging Guide directives](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/).

To get a screenshot included for software-center, please use https://screenshots.debian.net/packages

### NEW packages through Debian
Expand Down
4 changes: 2 additions & 2 deletions docs/staging/package-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ who needs to be aware of changes that you make for them to be included.
Soft freezes have no mechanism in the archive software to enforce them, they
just rely on each developer to ensure that they only upload appropriate changes.

For instance, [Feature Freeze](https://canonical-ubuntu-project.readthedocs-hosted.com/staging/freezes/feature-freeze) is a soft
For instance, {ref}`feature-freeze` is a soft
freeze, as you can still upload as before, you are just required to seek
exceptions for new features.

Expand Down Expand Up @@ -210,7 +210,7 @@ Packages sometimes move from one component to another, according to policy or
licensing changes, as managed by the archive administrators. Special
consideration is necessary when packages move into `main` or `restricted`, as
this implies a commitment of ongoing maintenance. Such changes must follow the
[Main Inclusion Process](https://canonical-ubuntu-project.readthedocs-hosted.com/MIR/main-inclusion-review).
{ref}`Main Inclusion Process <main-inclusion-review>`.

(package-archive-autobuilders)=
## Autobuilders
Expand Down
1 change: 1 addition & 0 deletions docs/staging/partner-archive.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(partner-archive)=
# Partner archive

The Canonical partner archive, though not part of Ubuntu proper, is managed
Expand Down