Skip to content

Commit 6360890

Browse files
authored
Fix RST formatting for monospace (#1688)
1 parent dfa191d commit 6360890

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/dev/debian.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,42 @@ Release Publishing
2323

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

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

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

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

0 commit comments

Comments
 (0)