[DEP-5] [patch] Renaming the Format-Specification field to ‘Format’.
Dear all,
I am going trough the DEP file in the Subversion repository from top to down,
dealing first with old issues, that were put on hold by my disagreements with
Steve, and will then address new issues raised this month. I want to take the
opportunity to thank Lars for giving a new momentum to the DEP.
The patches that I will send are not a stack, but I am willing to update them
on demand. They are made from branches of my git clone, but against one branch
that tracks the svn repository, not the master branch that contain experimental
features.
Renaming the Format-Specification field:
During the discussions on the wiki page
(http://wiki.debian.org/Proposals/CopyrightFormat/Archive#Ugliness), it was commented
that the format was ugly, and in particular that field names were unnecessary
long (see Carsten Hey's comment for instance). It was discussed a couple of
times that the Format-Specification field could be renamed ‘Format’ and I
do not remember objections. Here are URLs where this was proposed on public
mailing lists.
http://lists.debian.org/20091222222529.GA5291@foghorn.stateful.de
http://lists.debian.org/20091223034751.GA30472@kunpuu.plessy.org
http://lists.debian.org/20100709051009.GA11424@merveille.plessy.net
I think that the attached patch reflects the consensus and is ready to be applied.
The corresponding git branch is here:
http://git.debian.org/?p=users/plessy/license-summary.git;a=shortlog;h=refs/heads/format-field
Carsten Hey (and perhaps others) also questionned if the field should be
required and if it should contain an URL: http://lists.debian.org/20091222222529.GA5291@foghorn.stateful.de
This is not addressed by this patch.
The patch also suppresses the mention of a Lintian bug, closed long time ago.
Have a nice day,
--
Charles Plessy
Tsurumi, Kanagawa, Japan
>From 49d3459fec861b31afd327d9477967a6e296dde6 Mon Sep 17 00:00:00 2001
From: Charles Plessy <plessy@debian.org>
Date: Sat, 14 Aug 2010 11:01:59 +0900
Subject: [PATCH] =?UTF-8?q?=20#=20Renaming=20Format-Specification=20field=20to=20=E2=80=98Format=E2=80=99.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dep5.mdwn | 17 +++++++----------
1 files changed, 7 insertions(+), 10 deletions(-)
diff --git a/dep5.mdwn b/dep5.mdwn
index 152ff69..69b0f08 100644
--- a/dep5.mdwn
+++ b/dep5.mdwn
@@ -69,7 +69,7 @@ names or syntax rules.
## Sections
### Header Section (Once)
- * **`Format-Specification`**
+ * **`Format`**
* Required
* Single occurrence
* Syntax: URI of the format specification, such as:
@@ -77,9 +77,6 @@ names or syntax rules.
* Note that the unwieldy length of the URL should be solved in
future by hosting the specification at a shorter URL (including the
specification version).
- * Currently (2008-07-25) this field can trigger a lintian warning
-about excessive line length; an exception for the `Format-Specification`
-line is pending in [bug 491302](http://bugs.debian.org/491302).
* **`Name`**
* Optional
@@ -103,12 +100,12 @@ line is pending in [bug 491302](http://bugs.debian.org/491302).
Examples:
- Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
+ Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
Name: SOFTware
Maintainer: John Doe <john.doe@example.com>
Source: http://www.example.com/software/project
- Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
+ Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
Name: xyz
Maintainer: Jane Smith <jane.smith@example.com>
Source: http://www.example.com/gitwww
@@ -256,10 +253,10 @@ occur, without needing to parse or compare the full license text.
From time to time, licenses may be added to or removed from the list of
standard short names. Such changes in the list of short names will always
-be accompanied by changes to the recommended `Format-Specification` value.
+be accompanied by changes to the recommended `Format` value.
Implementors who are parsing copyright files should take care not to assume
anything about the meaning of license short names for unknown
-`Format-Specification` versions.
+`Format` versions.
Use of a standard short name does not override the Debian Policy requirement
to include the full license text in `debian/copyright`, nor any requirements
@@ -443,7 +440,7 @@ debian/control). However, other syntaxes could be used, such as YAML.
A possible `copyright` file for the program 'X Solitaire' distributed in the
Debian source package `xsol`:
- Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
+ Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
Name: X Solitaire
Source: ftp://ftp.example.com/pub/games
@@ -479,7 +476,7 @@ Debian source package `xsol`:
A possible `copyright` file for the program 'Planet Venus', distributed in the
Debian source package `planet-venus`:
- Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
+ Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
Name: Planet Venus
Maintainer: John Doe <jdoe@example.com>
Source: http://www.example.com/code/venus
--
1.6.5.7
Reply to: