Bug#1084911: debian-policy: include a Vcs-* example
Control: tag -1 + patch
Hello,
I am seeking seconds for the following patch below. The change is tiny
and aims only to improve the clarity of the policy by providing an
example. I submitted this originally already a year ago, but while
reviewing xz-utils this week, I once again saw that the field was
wrong (https://salsa.debian.org/debian/xz-utils/-/commit/3219ad6c7c54ea727e2ef8d1788ef31b344b1c9a)
and it reminded me that an example of the most typical contents would
be a useful addition to the policy.
± git format-patch --stdout -1 HEAD
Subject: [PATCH] Add an example of Vsc-* usage to make the section easy to
understand
When presenting the Vcs-Browser and Vcs-<type> fields, start by showing
one typical example. With the illustration visible it is much easier for
a new maintainer to read and grasp the technical definition on what all
syntax is allowed and what it means.
---
policy/ch-controlfields.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/policy/ch-controlfields.rst b/policy/ch-controlfields.rst
index 3151816..00131cd 100644
--- a/policy/ch-controlfields.rst
+++ b/policy/ch-controlfields.rst
@@ -1080,6 +1080,14 @@ repository where the Debian source package is developed.
``Vcs-Browser``
URL of a web interface for browsing the repository.
+ The example below illustrates the difference between the browsing
location and actual VCS
+ location:
+
+ .. code-block:: debcontrol
+
+ Vcs-Browser: https://salsa.debian.org/debian/grep
+ Vcs-Git: https://salsa.debian.org/debian/grep.git
+
``Vcs-<type>``
The field name identifies the VCS. The field's value uses the version
control system's conventional syntax for describing repository
--
The most polished version of this patch can at any time be found at
https://salsa.debian.org/otto/policy/-/commits/vcs-example
Reply to: