From: Charles Plessy
Date: Sat, 7 Jan 2012 06:00:30 +0000 (+0900)
Subject: Document VCS fields
X-Git-Url: https://git.donarmstrong.com/?p=debian%2Fdebian-policy.git;a=commitdiff_plain;h=2383cf44f168a0c6f8dfd4bf5c919f8893ea253e
Document VCS fields
Uses Developers's Reference §6.2.5 for inspiration.
Closes: #654958
[jrnieder@gmail.com:
- declared repositories should be publicly accessible
- Vcs-Browser should point to a webapp
- Vcs- should use the version control system's conventional syntax
- if multiple branches are used for packaging (e.g., "stable",
"testing", "sid"), any one of them will do
- for Vcs-Git, "-b " can be omitted when the intended branch is the
default branch
- list some Vcs- fields by name in the lists in §5.2 and §5.4
- declared repositories track development of the Debian source
package, not just the upstream code
- Vcs-Browser can be a web interface using any protocol (e.g., HTTPS
is fine)
- picking a good branch is optional
Thanks to Russ Allbery for several improvements to the text.]
---
diff --git a/policy.sgml b/policy.sgml
index aa42b5d..6e7c69e 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -2631,6 +2631,7 @@ Package: libc6
- Build-Depends et al
- Standards-Version (recommended)
- Homepage
+ - Vcs-Browser, Vcs-Git, et al.
@@ -2725,6 +2726,7 @@ Package: libc6
- Uploaders
- DM-Upload-Allowed
- Homepage
+ - Vcs-Browser, Vcs-Git, et al.
- Standards-Version (recommended)
- Build-Depends et al
- Checksums-Sha1
@@ -3739,6 +3741,53 @@ Checksums-Sha256:
details.
+
+
+ Version Control System (VCS) fields
+
+
+ Debian source packages are increasingly developed using VCSs. The
+ purpose of the following fields is to indicate a publicly accessible
+ repository where the Debian source package is developed.
+
+
+ Vcs-Browser
+ -
+
+ URL of a web interface for browsing the repository.
+
+
+
+
+ Vcs-Arch, Vcs-Bzr (Bazaar), Vcs-Cvs,
+ Vcs-Darcs, Vcs-Git, Vcs-Hg
+ (Mercurial), Vcs-Mtn (Monotone), Vcs-Svn
+ (Subversion)
+
+ -
+
+ The field name identifies the VCS. The field's value uses the
+ version control system's conventional syntax for describing
+ repository locations and should be sufficient to locate the
+ repository used for packaging. Ideally, it also locates the
+ branch used for development of new versions of the Debian
+ package.
+
+
+ In the case of Git, the value consists of a URL, optionally
+ followed by the word -b and the name of a branch in
+ the indicated repository, following the syntax of the
+ git clone command. If no branch is specified, the
+ packaging should be on the default branch.
+
+
+ More than one different VCS may be specified for the same
+ package.
+
+
+
+
+