r55 - /web/deps/dep5.mdwn

vorlon at users.alioth.debian.org vorlon at users.alioth.debian.org
Thu Jun 11 18:22:41 UTC 2009


Author: vorlon
Date: Thu Jun 11 18:22:41 2009
New Revision: 55

URL: http://svn.debian.org/wsvn/dep/?sc=1&rev=55
Log:
revert previous change:
- there are substantive changes to the spec here that are not the subject of
  consensus within the driver team and have not been subjected to prior
  public scrutiny.  Not gonna happen.
- the merge appears to have been done by hand instead of in a manner that would
  permit reverting individual revisions from bzr, so it all goes for now,
  including the changes that are a matter of consensus.

Modified:
    web/deps/dep5.mdwn

Modified: web/deps/dep5.mdwn
URL: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?rev=55&op=diff
==============================================================================
--- web/deps/dep5.mdwn (original)
+++ web/deps/dep5.mdwn Thu Jun 11 18:22:41 2009
@@ -6,10 +6,6 @@
 	Date: 2009-03-22
 	Drivers: Steve Langasek <vorlon at debian.org>, Charles Plessy <plessy at debian.org>, Noah Slater <nslater at tumbolia.org>, Simon Josefsson <simon at josefsson.org>
 	URL: http://dep.debian.net/deps/dep5
-	License:
-	 Copying and distribution of this file, with or without modification, are
-	 permitted in any medium without royalty provided the copyright notice and this
-	 notice are preserved.
 	Abstract:
 	 Establish a standard, machine-readable format for debian/copyright
 	 files within packages, to facilitate automated checking and
@@ -68,7 +64,7 @@
 ## Sections
 ### Header Section (Once)
 
- * **`Format`**
+ * **`Format-Specification`**
    * Required
    * Single occurrence
    * Suggested format: URI of the format specification, such as:
@@ -76,13 +72,16 @@
      * 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
    * Single occurrence
    * Single line (in most cases a single word), containing the name of the software.
 
- * **`Contact`**
+ * **`Maintainer`**
    * Optional
    * Single occurrence
    * Line(s) of RFC2822 address or URIs or free text, containing the preferred address(es) to reach current upstream maintainer(s).
@@ -99,14 +98,12 @@
 
 Examples:
 
-	Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=REVISION
 	Name: SOFTware
-	Contact: John Doe <john.doe at example.com>
+	Maintainer: John Doe <john.doe at example.com>
 	Source: http://www.example.com/software/project
 
-	Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=REVISION
 	Name: xyz
-	Contact: Jane Smith <jane.smith at example.com>
+	Maintainer: Jane Smith <jane.smith at example.com>
 	Source: http://www.example.com/gitwww
 
 ### Files Section (Repeatable)
@@ -116,11 +113,11 @@
 
  * **`Files`**
    * Required. However, the first **`Files`** field can be omitted and its value will be assumed to be '*'.
-   * List of space-separated globbing pathnames (see `man 7 glob` for more details) indicating files that have the same licence and share copyright holders.
-   * If multiple `Files` declaratioun match the same file, then only the last match counts.
+   * List of patterns indicating files having the same licence and sharing copyright holders. See "File patterns" below
 
  * **`Copyright`**
    * Optional
+   * Suggested name: **`Copyright`**
    * one or more free-form copyright statement(s) that apply to the files matched by the above pattern.
      * Example Format: 2008, John Q. Holder <john.holder at example.org>
 
@@ -174,10 +171,65 @@
 
 ### Extra fields.
 
-Extra fields can be added to any section. It is not recommended to prefix their
-name by **`X-`**.
+Extra fields can be added to any section. Their name starts by **`X-`**.
 
 ## Fields Detail
+### Files
+#### Format
+The **`Files`** field contains a list of comma-separated patterns 
+
+	Files: foo.c, bar.*, baz.[ch]
+
+File names containing spaces or commas should be put within double
+quotes. The backslash character is an escaping character, be it inside
+or outside double quotes:
+
+	Files: "Program Files/*", manual[english].txt
+
+#### Syntax
+Patterns are the ones recognised by the `find` utility's `-name`
+option and in case of the pattern contains path separator "/", it can be
+used for `-path` option.
+
+The following matches all `Makefile.am` files in the tree and all
+Python scripts:
+
+	Files: */Makefile.am, *.py
+
+But this will only match the top-level `Makefile.am`:
+
+	Files: ./Makefile.am
+
+The command for find from the first example would be:
+
+	find . -path "*/Makefile.am" -o -name "*.py"
+
+It is quite common for a work to have files with copyright held by
+different parties and received under different licenses. To accommodate
+this, **multiple stanzas are allowed with different `Files`
+declarations**.
+
+However it makes for easier reading if the copyright file lists the
+"main" license first: the one matching the "top level" of the work, with
+others listed as exceptions. To allow this, the following precedence
+rule applies for matching files: **If multiple `Files` declarations
+match the same file, then only the last match counts.**
+
+As a result, it is recommended for clarity that the stanzas appear in
+order from most general (e.g. `Files: *`) first, through to most
+specific. In the following example, the file `getopt.c` matches both
+`Files: *` and `Files: getopt.*`; only the last match counts, so
+the file `getopt.c` has the license declaration `License: BSD`.
+
+	Files: *
+	Copyright: 2003-2005, John Doe <jdoe at xample.com>
+	License: [the main work's license]
+	 [LICENSE TEXT]
+
+	Files: getopt.*
+	Copyright: 2000, The Corporation Foundation, Inc.
+	License: BSD
+	 [LICENSE TEXT]
 
 ### License
 #### Short name
@@ -191,38 +243,37 @@
 
 
 [[!table data="""
-**Keyword**    | **Meaning**. Links usually point to latest version.
-`Apache`       | [Apache](http://www.apache.org/licenses/LICENSE-2.0.txt) license.
-`Artistic`     | [Artistic](http://dev.perl.org/licenses/artistic.html) license.
-`BSD`          | [Berkeley software distribution](http://www.freebsd.org/copyright/license.html) license.
-`NetBSD`       | [NetBSD](http://www.netbsd.org/about/redistribution.html#default) Foundation's (TNF) license.
-`FreeBSD`      | [FreeBSD](http://www.freebsd.org/copyright/freebsd-license.html) Project license.
-`ISC`          | [Internet Software Consortium](https://www.isc.org/software/license)'s license, sometimes also known as the OpenBSD License.
-`CC-BY`        | Creative Commons [Attribution](http://creativecommons.org/licenses/by/3.0/) license.
-`CC-BY-SA`     | Creative Commons [Attribution Share Alike](http://creativecommons.org/licenses/by-sa/3.0/) license.
-`CC-BY-ND`     | Creative Commons [Attribution No Derivatives](http://creativecommons.org/licenses/by-nd/3.0/) license.
-`CC-BY-NC`     | Creative Commons [Attribution Non-Commercial](http://creativecommons.org/licenses/by-nc/3.0/) license.
-`CC-BY-NC-SA`  | Creative Commons [Attribution Non-Commercial Share Alike](http://creativecommons.org/licenses/by-nc-sa/3.0/) license.
-`CC-BY-NC-ND`  | Creative Commons [Attribution Non-Commercial No Derivatives](http://creativecommons.org/licenses/by-nc-nd/3.0/) license.
-`CC0`          | Creative Commons [Universal waiver](http://creativecommons.org/license/zero/).
-`CDDL`         | [Common Development and Distribution License](http://www.sun.com/cddl/cddl.html).
-`CPL`          | IBM [Common Public License](http://www.ibm.com/developerworks/library/os-cpl.html).
-`Eiffel`       | The [Eiffel](http://www.eiffel-nice.org/license/eiffel-forum-license-2.html) Forum License.
-`Expat`        | The [Expat](http://www.jclark.com/xml/copying.txt) license.
-`GPL`          | GNU [General Public License](http://www.gnu.org/copyleft/gpl.html).
-`LGPL`         | GNU [Lesser General Public License](http://www.gnu.org/licenses/lgpl.html) (GNU Library General Public License for versions lower than 2.1).
-`AGPL`         | GNU [Affero General Public License](http://www.gnu.org/licenses/agpl.html).
-`GFDL`         | [GNU Free Documentation License](http://www.gnu.org/licenses/fdl.html).
-`GAP`          | [GNU All Permissive](http://www.gnu.org/licenses/license-list.html#GNUAllPermissive) license.
-`LPPL`         | [LaTeX Project Public License](http://www.latex-project.org/lppl/).
-`MPL`          | [Mozilla Public License](http://www.mozilla.org/MPL/MPL-1.1.html).
-`Perl`         | [Perl](http://dev.perl.org/licenses/) license (equates to "GPL-1+ or Artistic-1
-`PHP`          | [PHP](http://www.php.net/license/) license.
-`PSF`          | [Python Software Foundation](http://www.python.org/psf/license/) license.
-`QPL`          | [Q Public License](http://doc.trolltech.com/3.0/license.html).
-`W3C-Software` | [W3C Software](http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231) License.
-`Zope`         | [Zope Public License](http://www.zope.org/Resources/License/).
-`other`        | Any other custom license. *License notice text must be copied verbatim.*i
+**keyword** | **meaning**
+`Apache` | Apache license
+`Artistic` | Artistic license
+`BSD` | Berkeley software distribution license
+`NetBSD` | NetBSD Foundation's (TNF) license
+`FreeBSD` | FreeBSD Project license
+`ISC` | Internet Software Consortium's license, sometimes also known as the OpenBSD License
+`CC-BY` | Creative Commons Attribution license
+`CC-BY-SA` | Creative Commons Attribution Share Alike license
+`CC-BY-ND` | Creative Commons Attribution No Derivatives
+`CC-BY-NC` | Creative Commons Attribution Non-Commercial
+`CC-BY-NC-SA` | Creative Commons Attribution Non-Commercial Share Alike
+`CC-BY-NC-ND` | Creative Commons Attribution Non-Commercial No Derivatives
+`CC0` | Creative Commons Universal waiver
+`CDDL` | Common Development and Distribution License
+`CPL` | IBM Common Public License
+`Eiffel` | The Eiffel Forum License
+`Expat` | The Expat license
+`GPL` | GNU General Public License
+`LGPL` | GNU Lesser General Public License, (GNU Library General Public License for versions lower than 2.1)
+`GFDL` | GNU Free Documentation License
+`LPPL` | LaTeX Project Public License
+`MPL` | Mozilla Public License
+`Perl` | Perl license (equates to "GPL-1+ or Artistic-1
+`PHP` | PHP license
+`PSF` | Python Software Foundation license
+`QPL` | Q Public License
+`W3C-Software` | W3C Software License
+`ZLIB` | zlib/libpng license
+`Zope` | Zope Public License
+`other` | Any other custom license. *License notice text must be copied verbatim.*
 """]]
 
 Exemptions and clarifications are signalled in plain text, by "with
@@ -235,6 +286,12 @@
 text needed is:
 
 The GPL "`OpenSSL`" clarification gives permission to linked code with OpenSSL library, which contains GPL-incompatible clauses.
+
+
+[[!table data="""
+**keyword** | **Version needed?** | **GPL compatible** | **meaning**
+`MIT` |<bgcolor="#ffebbb"> No | | Several variants of the MIT license exist: (1) the standard version with three paragraphs (blanket permission, keep this notice, NO WARRANTY), (2) a version with a no-endorsement clause, and (3) other versions with slight wording differences. *License notice text needs to be copied verbatim.*
+`PD` |<bgcolor="#ffebbb"> No | | Being in the public domain is not a license. See Linux journal article ["Why the Public Domain Isn't a License"](http://www.linuxjournal.com/article/6225) by Lawrence Rosen. *License notice text needs to be copied verbatim*
 
 #### Syntax
 License names are case-insensitive.
@@ -295,7 +352,6 @@
 #### Simple
 A possible `copyright` file for the program 'X Solitaire' distributed in the Debian source package `xsol`:
 
-		Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=REVISION
 		Name: X Solitaire
 		Source: ftp://ftp.example.com/pub/games
 
@@ -313,9 +369,8 @@
 #### Complex
 A possible `copyright` file for the program 'Planet Venus', distributed in the Debian source package `planet-venus`:
 
-		Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=REVISION
 		Name: Planet Venus
-		Contact: John Doe <jdoe at example.com>
+		Maintainer: John Doe <jdoe at example.com>
 		Source: http://www.example.com/code/venus
 
 		Copyright: 2008, John Doe <jdoe at example.com>




More information about the dep-commits mailing list