Bug#953911: debian-policy: clarify documentation of "Closes: #NNNNNN" changelog syntax
Package: debian-policy
Version: 4.5.0.0
Severity: wishlist
Tags: patch upstream
Dear Maintainer,
The documentation of the "Closes: #NNNNNN" changelog syntax describes
the syntax in terms of a Perl regular expression. However, not all
readers know Perl. I suggest to describe the semantics in English,
in addition to or instead of the description in Perl.
Cheers,
Daniel
diff --git a/policy/ch-source.rst b/policy/ch-source.rst
index 1d870d9..46fca24 100644
--- a/policy/ch-source.rst
+++ b/policy/ch-source.rst
@@ -151,9 +151,9 @@ used here to separate groups of changes, if desired.
If this upload resolves bugs recorded in the Bug Tracking System (BTS),
they may be automatically closed on the inclusion of this package into
the Debian archive by including the string: ``closes: Bug#nnnnn`` in
-the change details. [#]_ This information is conveyed via the
-``Closes`` field in the ``.changes`` file (see
-:ref:`s-f-Closes`).
+the change details, where ``#nnnnn`` is the bug number. [#]_ This
+information is conveyed via the ``Closes`` field in the ``.changes``
+file (see :ref:`s-f-Closes`).
The maintainer name and email address used in the changelog should be
the details of the person who prepared this release of the package. They
@@ -853,17 +853,21 @@ should not exist a file ``debian/patches/foo.series`` for any ``foo``.
maintain the package as a non-native package.
.. [#]
- To be precise, the string should match the following Perl regular
- expression:
+ To be precise, the string should consist of the word ``closes:``
+ followed by a comma-separated list of bug numbers. Bug numbers
+ may be preceded by the word ``bug`` and/or a ``#`` sign, as in
+ ``Closes: 42, bug#43, #44, bug 45``.
- ::
-
- /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i
-
- Then all of the bug numbers listed will be closed by the archive
+ All of the bug numbers listed will be closed by the archive
maintenance software (``dak``) using the version of the changelog
entry.
+ All of the bug numbers listed must be given on the same physical line
+ as the word ``closes:``. However, a single changelog entry may contain
+ multiple ``closes:`` directives.
+
+ The words ``closes:`` and ``bug`` are not case sensitive.
+
.. [#]
In the case of a sponsored upload, the uploader signs the files, but
the changelog maintainer name and address are those of the person who
Reply to: