Skip to content

Fix RST formatting for monospace #1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2024
Merged
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
38 changes: 19 additions & 19 deletions docs/dev/debian.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,42 +23,42 @@ Release Publishing

To publish a new release Debian package, perform the following:

1. Change to the packaging branch, `git checkout debian/unstable`, and make sure
the working directorty is clean, `git status`, and up-to-date, `git pull`.
2. Merge the release tag, `git merge 1.xx.y`; if there is a conflict (which
1. Change to the packaging branch, ``git checkout debian/unstable``, and make sure
the working directorty is clean, ``git status``, and up-to-date, ``git pull``.
2. Merge the release tag, ``git merge 1.xx.y``; if there is a conflict (which
should be rare), then it may be better to pass some additional options,
`git merge -sort -Xtheirs 1.xx.y`.
``git merge -sort -Xtheirs 1.xx.y``.
3. Verify that there are no extraneous differences from the release tag,
`git diff 1.xx.y..HEAD --stat -- . ':!debian'`; the command should produce
``git diff 1.xx.y..HEAD --stat -- . ':!debian'``; the command should produce
no output, and if any output is shown then that indicates differences in
files outside the `debian/` directory.
4. If there were any files outside the `debian/` directory listed in the last
step then replace them, `git checkout 1.xx.y -- path/to/file1 path/to/file2`.
files outside the ``debian/`` directory.
4. If there were any files outside the ``debian/`` directory listed in the last
step then replace them, ``git checkout 1.xx.y -- path/to/file1 path/to/file2``.
Commit these changes,
`git commit -m "Fix-up, post Merge tag '1.xx.y' into debian/unstable"` and
``git commit -m "Fix-up, post Merge tag '1.xx.y' into debian/unstable"`` and
repeat step 3.
5. Create a new changelog entry (use the command `dch -i` to ensure proper
5. Create a new changelog entry (use the command ``dch -i`` to ensure proper
formatting), then adjust the version number on the top line of the changelog
as appropriate.
6. Make any other necessary changes to the Debian packaging components (e.g.,
update to standards version, dependencies, descriptions, etc.) and make
relevant entries in ``debian/changelog`` as needed.
7. Use `git add` to stage the changed files for commit (only files in the
`debian/` directory should be committed), then commit them (the `debcommit`
7. Use ``git add`` to stage the changed files for commit (only files in the
``debian/`` directory should be committed), then commit them (the ``debcommit``
utility is helpful here).
8. Build the package with `gbp buildpackage` and inspect the resulting package
files (at a minimum use `debc` on the `.changes` file in order to confirm
8. Build the package with ``gbp buildpackage`` and inspect the resulting package
files (at a minimum use ``debc`` on the ``.changes`` file in order to confirm
files are installed to the proper locations by the proper packages and also
use `lintian` on the `.changes` file in order to confirm that there are no
unexpected errors or warnings; the `lintian` used for this check should
use ``lintian`` on the ``.changes`` file in order to confirm that there are no
unexpected errors or warnings; the ``lintian`` used for this check should
always be the latest version as it is found in the unstable distribution)
9. If any changes are needed, make them, commit them, and rebuild the package.

.. note:: It may be desirable to squash multiple commits down to a single commit before building the final packages.

10. Once the final packages are built, they can be signed and uploaded and the
version can be tagged using the `--git-tag` option of `gbp buildpackage`.
version can be tagged using the ``--git-tag`` option of ``gbp buildpackage``.
The best approach is to build the packages, prepare everything and then
upload. Once the archive has accepted the upload, then execute
`gbp buildpackage --git-tag --git-tag-only --git-sign-tags` and push the
commits on the `debian/unstable` branch as well as the new signed tag.
``gbp buildpackage --git-tag --git-tag-only --git-sign-tags`` and push the
commits on the ``debian/unstable`` branch as well as the new signed tag.