[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: DEP5: Format example patch



On Tue, Jan 18, 2011 at 10:58:41PM +0100, Jonas Smedegaard wrote:
> >       I would rather avoid it, though, since then the examples
> >need        to be updated every time, and I'm lazy.
> 
> I see no need for updating every time.  They are *examples*.

Agreed to both, but don't underestimate the risks of copy-paste. I
suggest the attached patch, which uses an explicit invalid placeholder
in the examples, hoping it's clear enough that it's a placeholder. The
rationale is that when copy-pasted, the copy-paster will notice that
it's a placeholder and look up the appropriate (and current) versioned
URL. An additional advantage of using a placeholder is that DEP5
implementation can easily detect that the placeholder is not a
well-formed URL (Dominique: does your current implementation do that, by
the way?).

Cheers.

-- 
Stefano Zacchiroli -o- PhD in Computer Science \ PostDoc @ Univ. Paris 7
zack@{upsilon.cc,pps.jussieu.fr,debian.org} -<>- http://upsilon.cc/zack/
Quando anche i santi ti voltano le spalle, |  .  |. I've fans everywhere
ti resta John Fante -- V. Capossela .......| ..: |.......... -- C. Adams
Index: web/deps/dep5.mdwn
===================================================================
--- web/deps/dep5.mdwn	(revision 164)
+++ web/deps/dep5.mdwn	(working copy)
@@ -188,7 +188,7 @@
 
 Example:
 
-    Format: http://dep.debian.net/deps/dep5/
+    Format: <VERSIONED_FORMAT_URL>
     Upstream-Name: SOFTware
     Upstream-Contact: John Doe <john.doe@example.com>
     Source: http://www.example.com/software/project
@@ -578,7 +578,7 @@
 A possible `copyright` file for the program 'X Solitaire' distributed in the
 Debian source package `xsol`:
 
-    Format: http://dep.debian.net/deps/dep5/
+    Format: <VERSIONED_FORMAT_URL>
     Upstream-Name: X Solitaire
     Source: ftp://ftp.example.com/pub/games
 
@@ -616,7 +616,7 @@
 A possible `copyright` file for the program 'Planet Venus', distributed in the
 Debian source package `planet-venus`:
 
-    Format: http://dep.debian.net/deps/dep5/
+    Format: <VERSIONED_FORMAT_URL>
     Upstream-Name: Planet Venus
     Upstream-Contact: John Doe <jdoe@example.com>
     Source: http://www.example.com/code/venus

Attachment: signature.asc
Description: Digital signature


Reply to: