r124 - /web/deps/dep5.mdwn
vorlon at users.alioth.debian.org
vorlon at users.alioth.debian.org
Thu Dec 17 15:25:04 UTC 2009
Author: vorlon
Date: Thu Dec 17 15:24:59 2009
New Revision: 124
URL: http://svn.debian.org/wsvn/dep/?sc=1&rev=124
Log:
cosmetic-only changes: clean up spelling/grammar, mark the field syntax
definitions with 'Syntax:', clarify language where necessary, and drop some
accidentally duplicated text
Modified:
web/deps/dep5.mdwn
Modified: web/deps/dep5.mdwn
URL: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?rev=124&op=diff
==============================================================================
--- web/deps/dep5.mdwn (original)
+++ web/deps/dep5.mdwn Thu Dec 17 15:24:59 2009
@@ -72,7 +72,7 @@
* **`Format-Specification`**
* Required
* Single occurrence
- * Suggested format: URI of the format specification, such as:
+ * Syntax: URI of the format specification, such as:
* http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=REVISION
* Note that the unwieldy length of the URL should be solved in
future by hosting the specification at a shorter URL (including the
@@ -84,22 +84,22 @@
* **`Name`**
* Optional
* Single occurrence
- * Single line (in most cases a single word), containing the name of the software.
+ * Syntax: Single line (in most cases a single word), containing the name of the software.
* **`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).
+ * Syntax: Line(s) containing the preferred address(es) to reach current upstream maintainer(s). May be free-form text, but by convention will usually be written as a list of RFC2822 addresses or URIs.
* **`Source`**
* Optional
* Single occurrence
- * Suggested format: line(s) of URIs, indicating the primary point of distribution of the software.
+ * Syntax: One or more URIs, one per line, indicating the primary point of distribution of the software.
* **`Disclaimer`**
* Optional
* Single occurrence
- * Free content. On Debian systems, this field can be used in the case of non-free and contrib packages (see [Policy 12.5](http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile)
+ * Syntax: Free-form text. On Debian systems, this field can be used in the case of non-free and contrib packages (see [Policy 12.5](http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile)
Examples:
@@ -119,20 +119,20 @@
more stanzas.
* **`Files`**
- * Required. However, the first **`Files`** field can be omitted and its value will be assumed to be '*'.
- * List of patterns indicating files having the same license and sharing copyright holders. See "File patterns" below
+ * Required for all but the first stanza. If omitted from the first stanza, this is equivalent to a value of '*'.
+ * Syntax: List of patterns indicating files having the same license 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>
+ * Syntax: one or more free-form copyright statement(s) that apply to the files matched by the above pattern.
+ * Example value: 2008, John Q. Holder <john.holder at example.org>
* **`License`**
- * Licensing terms for the files listed in the previous **`Files`** field
- * First line: license name(s) in abbreviated format (see *Short names* section). If empty, it is given the default value 'other'
- * Remaining lines: either copy the full text of the license(s), indicate a link to it (or them), or leave this part empty for using standalone **`License`** section(s) that matches the license short name(s) (see the *Standalone License Section* section).
- * If the files have no copyright holders nor license because they are in the Public Domain, the **`License`** field is used to indicate this fact.
+ * Licensing terms for the files listed in **`Files`** field for this section
+ * Syntax:
+ * First line: an abbreviated name for the license (see *Short names* section for a list of standard abbreviations). If empty, it is given the default value 'other'.
+ * Remaining lines: either copy the full text of the license(s), indicate a link to it (or them), or leave this part empty for using standalone **`License`** section(s) that matches the license short name(s) (see the *Standalone License Section* section).
+ * If the files have no copyright holders nor license because they are in the Public Domain, the **`License`** field is used to indicate this fact.
Example:
@@ -143,7 +143,9 @@
[LICENSE TEXT]
### Standalone License Section
-Where a set of files are dual (tri, etc) licensed, or when the same license occurs multiple times, you can use a single line **`License`** field and standalone **`License`** fields to expand the license short names.
+Where a set of files are dual (tri, etc) licensed, or when the same license
+occurs multiple times, you can use a single line **`License`** field and
+standalone **`License`** stanzas to expand the license short names.
Example 1 (tri-licensed files).
@@ -166,7 +168,7 @@
Files: src/js/editline/*
Copyright: 1993, John Doe
- 1993, Joe Average
+ 1993, Joe Average
License: MPL-1.1
Files: src/js/fdlibm/*
@@ -183,7 +185,7 @@
## Fields Detail
### Files
#### Format
-The **`Files`** field contains a list of comma-separated patterns
+The **`Files`** field contains a list of comma-separated patterns
Files: foo.c, bar.*, baz.[ch]
@@ -194,9 +196,9 @@
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.
+Patterns are handled as by the `find` utility's `-name` option. Patterns
+containing a path separator ("/") are handled as by the `find` utility's
+`-path` option.
The following matches all `Makefile.am` files in the tree and all
Python scripts:
@@ -207,7 +209,7 @@
Files: ./Makefile.am
-The command for find from the first example would be:
+For the first example, the equivalent `find` command would be:
find . -path "*/Makefile.am" -o -name "*.py"
@@ -241,12 +243,15 @@
### License
#### Short name
-The "`License`" field, to be machine-parseable, refers in its first lines to
-frequently used licenses through a list of unambiguous short names. For the
-licenses existing in multiple versions, the version number is added, using a
-dash as a separator. If omitted, the lowest version number is implied. When the
-license permits to use the terms of any later version, the short name is
-finished with a plus sign.
+Much of the value of a machine-parseable copyright file lies in being able to
+correlate the licenses of multiple pieces of software. To that end, this
+spec defines standard short names for a number of commonly used licenses,
+which can be used in the first line of a "`License`" field.
+
+For licenses which have multiple versions in use, the version number is
+added, using a dash as a separator. If omitted, the lowest version number is
+implied. When the license grant permits using the terms of any later version
+of that license, the short name is finished with a plus sign.
[[!table data="""
@@ -342,9 +347,9 @@
#### Syntax
License names are case-insensitive.
-In case of multi-licensing, the license short names are separated by `or` for
-code where the user can chose between different licenses, and by `and` for code
-whose use must comply with the terms of multiple licenses.
+In case of multi-licensing, the license short names are separated by `or`
+when the user can chose between different licenses, and by `and` when use
+of the work must simultaneously comply with the terms of multiple licenses.
For instance, this is a simple, "GPL version 2 or later" field:
@@ -396,7 +401,8 @@
### Examples in pseudo-RFC-822 format
#### Simple
-A possible `copyright` file for the program 'X Solitaire' distributed in the Debian source package `xsol`:
+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=19
Name: X Solitaire
@@ -414,7 +420,8 @@
[LICENSE TEXT]
#### Complex
-A possible `copyright` file for the program 'Planet Venus', distributed in the Debian source package `planet-venus`:
+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=19
Name: Planet Venus
@@ -466,7 +473,7 @@
## Appendix: Note about the use of this format in Debian
-The Debian Policy (§12.5) demands that each packages is accompanied by a file,
+The Debian Policy (§12.5) demands that each package is accompanied by a file,
`debian/copyright` in source packages and `/usr/share/doc/package/copyright` in
binary packages, that contains a verbatim copy of its copyright and
distribution license. In addition, it requires that copyrights must be
@@ -478,14 +485,6 @@
The copyright of the Debian packaging and the history of package maintainers is
simply indicated in a **`Files: debian/*`** section.
-In the case packages in the contrib or non-free sections of the Debian archive,
-the **`Disclaimer`** field can be used for explaining that the contrib or
-non-free package is not part of the Debian GNU/Linux distribution and briefly
-explain why (as per Policy §12.5).
-
-The copyright of the Debian packaging and the history of package maintainers is
-simply indicated in a **`Files: debian/*`** section.
-
The Policy section §12.5 demands that packages distributed in the ''non-free''
and ''contrib'' sections of the Debian archive carry a disclaimer in
`debian/copyright` that reminds that these packages are not part of the Debian
More information about the dep-commits
mailing list