r233 - in /web/deps: ./ dep5/copyright-format.xml dep5/index.html
vorlon at users.alioth.debian.org
vorlon at users.alioth.debian.org
Tue Dec 13 18:33:59 UTC 2011
Author: vorlon
Date: Tue Dec 13 18:33:58 2011
New Revision: 233
URL: http://svn.debian.org/wsvn/dep/?sc=1&rev=233
Log:
merge the addition of the 'Fields' section
Modified:
web/deps/ (props changed)
web/deps/dep5/copyright-format.xml
web/deps/dep5/index.html
Modified: web/deps/dep5/copyright-format.xml
URL: http://svn.debian.org/wsvn/dep/web/deps/dep5/copyright-format.xml?rev=233&op=diff
==============================================================================
--- web/deps/dep5/copyright-format.xml (original)
+++ web/deps/dep5/copyright-format.xml Tue Dec 13 18:33:58 2011
@@ -187,100 +187,66 @@
<section id="header-paragraph">
<title>Header paragraph (Once)</title>
- <section id="format-header-field">
- <title><varname>Format</varname></title>
- <para>
- Required single line: URI of the format specification, such as:
- <literal>http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</literal>
- </para>
- </section>
-
- <section id="upstream-name-header-field">
- <title><varname>Upstream-Name</varname></title>
- <para>
- Optional single line: the name upstream uses for the software
- </para>
- </section>
-
- <section id="upstream-contact-header-field">
- <title><varname>Upstream-Contact</varname></title>
- <para>
- Optional line based list: the preferred address(es) to reach the
- upstream project. May be free-form text, but by convention will
- usually be written as a list of RFC5322 addresses or URIs.
- </para>
- </section>
-
- <section id="source-header-field">
- <title><varname>Source</varname></title>
- <para>
- Optional formatted text, no synopsis: an explanation from where the
- upstream source came from. Typically this would be a URL, but it might
- be a free-form explanation. The Debian Policy section <ulink
- url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>
- requires this information unless there are no upstream sources, which
- is mainly the case for native Debian packages. If the upstream source
- has been modified to remove non-free parts, that should be explained
- in this field.
- </para>
- </section>
-
- <section id="disclaimer-header-field">
- <title><varname>Disclaimer</varname></title>
- <para>
- Optional formatted text, no synopsis: this field can be used in the
- case of non-free and contrib packages (see <ulink
- url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>)
- </para>
- </section>
-
- <section id="comment-header-field">
- <title><varname>Comment</varname></title>
- <para>
- Optional formatted text, no synopsis: this field can provide
- additional information. For example, it might quote an e-mail from
- upstream justifying why the license is acceptable to the main archive,
- or an explanation of how this version of the package has been forked
- from a version known to be DFSG-free, even though the current upstream
- version is not.
- </para>
- </section>
-
- <section id="license-header-field">
- <title><varname>License</varname></title>
- <para>
- Optional formatted text, with synopsis: in the header paragraph
- (no <varname>Files</varname> specification), this field gives the
- license information for the package as a whole, which may be different
- or simplified from a combination of all the per-file license
- information. See also <varname>License</varname> below in the
- <link linkend="files-paragraph">Files paragraph</link> section.
- </para>
- </section>
-
- <section id="copyright-header-field">
- <title><varname>Copyright</varname></title>
- <para>
- Optional line based list: in the header paragraph (no
- <varname>Files</varname> specification), this field gives the
- copyright information for the package as a whole, which may be
- different or simplified from a combination of all the per-file
- copyright information. See also <varname>Copyright</varname> below
- in the <link linkend="files-paragraph">Files paragraph</link>
- section.
- </para>
- <para>
- The <varname>Copyright</varname> and <varname>License</varname> fields
- in the <emphasis>header paragraph</emphasis> may complement but do not
- replace the <emphasis>files paragraphs</emphasis>. They can be used
- to summarise the contributions and redistribution terms for the whole
- package, for instance when a work combines a permissive and a copyleft
- license, or to document a <emphasis>compilation copyright</emphasis>
- and license. It is possible to use only <varname>License</varname> in
- the header paragraph, but <varname>Copyright</varname> alone makes no
- sense.
- </para>
- </section>
+ <para>
+ The following fields may be present in a header paragraph.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="format-field">Format</link>: required.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="upstream-name-field">Upstream-Name</link>:
+ optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link
+ linkend="upstream-contact-field">Upstream-Contact</link>:
+ optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="source-field">Source</link>: optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="disclaimer-field">Disclaimer</link>:
+ optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="comment-field">Comment</link>: optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="license-field">License</link>: optional.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="copyright-field">Copyright</link>: optional.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The <varname>Copyright</varname> and <varname>License</varname>
+ fields in the <emphasis>header paragraph</emphasis> may complement
+ but do not replace the <emphasis>Files paragraphs</emphasis>. They
+ can be used to summarise the contributions and redistribution terms
+ for the whole package, for instance when a work combines a
+ permissive and a copyleft license, or to document a
+ <emphasis>compilation copyright</emphasis> and license. It is
+ possible to use only <varname>License</varname> in the header
+ paragraph, but <varname>Copyright</varname> alone makes no sense.
+ </para>
<section id="example-header-paragraph">
<title>Example header paragraph</title>
@@ -291,7 +257,7 @@
</section>
</section>
- <section id="files-paragraph">
+ <section id="files-paragraph">
<title>Files paragraph (Repeatable)</title>
<para>
The declaration of copyright and license for files is done in one or
@@ -299,17 +265,273 @@
which applies to all files and lists all applicable copyrights and
licenses.
</para>
-
- <section id="files-files-field">
- <title><varname>Files</varname></title>
+ <para>
+ The following fields may be present in a Files paragraph.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="files-field">Files</link>: required.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="license-field">Copyright</link>: required.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="license-field">License</link>: required.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="comment-field">Comment</link>: optional.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="example-files-paragraph">
+ <title>Example files paragraphs</title>
+<programlisting>Files: *
+Copyright: 1975-2010 Ulla Upstream
+License: GPL-2+
+
+Files: debian/*
+Copyright: 2010 Daniela Debianizer
+License: GPL-2+
+
+Files: debian/patches/fancy-feature
+Copyright: 2010 Daniela Debianizer
+License: GPL-3+
+
+Files: */*.1
+Copyright: 2010 Manuela Manpager
+License: GPL-2+</programlisting>
<para>
- Required whitespace-separated list: list of patterns indicating files
- covered by the license and copyright specified in this paragraph.
+ In this example, all files are copyright by the upstream and licensed
+ under the GPL, version 2 or later, with three exceptions. All the
+ Debian packaging files are copyright by the packager, and further one
+ specific file providing a new feature is licensed differently.
+ Finally, there are some manual pages added to the package, written by
+ a third person.
</para>
- <para>
- Filename patterns in the <varname>Files</varname> field are specified
- using a simplified shell glob syntax. Patterns are separated by
- whitespace.
+ </section>
+ </section>
+
+ <section id="stand-alone-license-paragraph">
+ <title>Standalone License Paragraph (Optional, Repeatable)</title>
+ <para>
+ Where a set of files are dual (tri, etc) licensed, or when the same
+ license occurs multiple times, you can use a single line
+ <varname>License</varname> field and standalone
+ <varname>License</varname> paragraphs to expand the license short names.
+ </para>
+ <para>
+ The following fields may be present in a standalone license
+ paragraph.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="license-field">License</link>: required.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="comment-field">Comment</link>: optional.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <example>
+ <title>tri-licensed files</title>
+<programlisting>Files: src/js/editline/*
+Copyright: 1993, John Doe
+ 1993, Joe Average
+License: MPL-1.1 or GPL-2 or LGPL-2.1
+
+License: MPL-1.1
+ [LICENSE TEXT]
+
+License: GPL-2
+ [LICENSE TEXT]
+
+License: LGPL-2.1
+ [LICENSE TEXT]</programlisting>
+ </example>
+
+ <example>
+ <title>recurrent license</title>
+<programlisting>Files: src/js/editline/*
+Copyright: 1993, John Doe
+ 1993, Joe Average
+License: MPL-1.1
+
+Files: src/js/fdlibm/*
+Copyright: 1993, J-Random Corporation
+License: MPL-1.1
+
+License: MPL-1.1
+ [LICENSE TEXT]</programlisting>
+ </example>
+ </section>
+ </section>
+
+ <section id="fields">
+ <title>Fields</title>
+ <para>
+ The following fields are defined for use in
+ <filename>debian/copyright</filename>.
+ </para>
+
+ <section id="format-field">
+ <title><varname>Format</varname></title>
+ <para>
+ Single-line: URI of the format specification, such as:
+ <literal>http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</literal>.
+ Required in <link linkend="header-paragraph">header
+ paragraphs</link>.
+ </para>
+ </section>
+
+ <section id="upstream-name-field">
+ <title><varname>Upstream-Name</varname></title>
+ <para>
+ Single-line: the name upstream uses for the software
+ </para>
+ </section>
+
+ <section id="upstream-contact-field">
+ <title><varname>Upstream-Contact</varname></title>
+ <para>
+ Line-based list: the preferred address(es) to reach the upstream
+ project. May be free-form text, but by convention will usually be
+ written as a list of RFC5322 addresses or URIs.
+ </para>
+ </section>
+
+ <section id="source-field">
+ <title><varname>Source</varname></title>
+ <para>
+ Formatted text, no synopsis: an explanation from where the upstream
+ source came from. Typically this would be a URL, but it might be a
+ free-form explanation. The Debian Policy section <ulink
+ url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>
+ requires this information unless there are no upstream sources,
+ which is mainly the case for native Debian packages. If the
+ upstream source has been modified to remove non-free parts, that
+ should be explained in this field.
+ </para>
+ </section>
+
+ <section id="disclaimer-field">
+ <title><varname>Disclaimer</varname></title>
+ <para>
+ Formatted text, no synopsis: this field can be used in the case of
+ non-free and contrib packages (see <ulink
+ url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>).
+ </para>
+ </section>
+
+ <section id="comment-field">
+ <title><varname>Comment</varname></title>
+ <para>
+ Formatted text, no synopsis: this field can provide additional
+ information. For example, it might quote an e-mail from upstream
+ justifying why the license is acceptable to the main archive, or an
+ explanation of how this version of the package has been forked from
+ a version known to be DFSG-free, even though the current upstream
+ version is not.
+ </para>
+ </section>
+
+ <section id="license-field">
+ <title><varname>License</varname></title>
+ <para>
+ Formatted text, with synopsis. In the header paragraph, this field
+ gives the license information for the package as a whole, which may
+ be different or simplified from a combination of all the per-file
+ license information. In a Files paragraph, this field gives the
+ licensing terms for the files listed in the <varname>Files</varname>
+ field for this paragraph. In a stand-alone license paragraph, it
+ gives the licensing terms for those paragraphs which reference it.
+ </para>
+ <para>
+ First line: an abbreviated name for the license, or expression
+ giving alternatives (see <link linkend="license-short-name">Short
+ names</link> section for a list of standard abbreviations). If
+ there are licenses present in the package without a standard short
+ name, an arbitrary short name may be assigned for these licenses.
+ These arbitrary names are only guaranteed to be unique within a
+ single copyright file.
+ </para>
+ <para>
+ Remaining lines: if left blank here, the file
+ <emphasis>must</emphasis> include a stand-alone
+ <varname>License</varname> paragraph matching each license short
+ name listed on the first line (see the <link
+ linkend="stand-alone-license-paragraph">Standalone License
+ Paragraph</link> section). Otherwise, this field should either
+ include the full text of the license(s) or include a pointer to the
+ license file under <filename>/usr/share/common-licenses</filename>.
+ This field should include all text needed in order to fulfill both
+ Debian Policy's requirement for including a copy of the software's
+ distribution license (<ulink
+ url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>),
+ and any license requirements to include warranty disclaimers or
+ other notices with the binary package.
+ </para>
+ </section>
+
+ <section id="copyright-field">
+ <title><varname>Copyright</varname></title>
+ <para>
+ Line-based list: one or more free-form copyright statement(s), one
+ per line. In the header paragraph, this field gives the copyright
+ information for the package as a whole, which may be different or
+ simplified from a combination of all the per-file copyright
+ information. In the Files paragraphs, it gives the copyright
+ information that applies to the files matched by the
+ <varname>Files</varname> pattern. If a work has no copyright holder
+ (i.e., it is in the public domain), that information should be
+ recorded here.
+ </para>
+ <para>
+ The <varname>Copyright</varname> field collects all relevant
+ copyright notices for the files of this paragraph. Not all
+ copyright notices may apply to every individual file, and years of
+ publication for one copyright holder may be gathered together. For
+ example, if file A has:
+<programlisting>Copyright 2008 John Smith
+Copyright 2009 Angela Watts</programlisting>
+ and file B has:
+<programlisting>Copyright 2010 Angela Watts</programlisting>
+ the <varname>Copyright</varname> field for a stanza covering both
+ file A and file B need contain only:
+<programlisting>Copyright 2008 John Smith
+Copyright 2009, 2010 Angela Watts</programlisting>
+ </para>
+ <para>
+ The <varname>Copyright</varname> field may contain the original
+ copyright statement copied exactly (including the word
+ <quote>Copyright</quote>), or it can shorten the text, as long as it
+ does not sacrifice information. Examples in this specification use
+ both forms.
+ </para>
+ </section>
+
+ <section id="files-field">
+ <title><varname>Files</varname></title>
+ <para>
+ Whitespace-separated list: list of patterns indicating files covered
+ by the license and copyright specified in this paragraph.
+ </para>
+ <para>
+ Filename patterns in the <varname>Files</varname> field are
+ specified using a simplified shell glob syntax. Patterns are
+ separated by whitespace.
<itemizedlist>
<listitem>
<para>
@@ -324,14 +546,14 @@
Patterns match pathnames that start at the root of the source
tree. Thus, <quote><filename>Makefile.in</filename></quote>
matches only the file at the root of the tree, but
- <quote><filename>*/Makefile.in</filename></quote> matches at any
- depth.
+ <quote><filename>*/Makefile.in</filename></quote> matches at
+ any depth.
</para>
</listitem>
<listitem>
<para>
- The backslash (<literal>\</literal>) is used to remove the magic
- from the next character; see table below.
+ The backslash (<literal>\</literal>) is used to remove the
+ magic from the next character; see table below.
</para>
</listitem>
</itemizedlist>
@@ -369,151 +591,9 @@
Exclusions are done by having multiple <varname>Files</varname>
paragraphs.
</para>
- </section>
-
- <section id="copyright-files-field">
- <title><varname>Copyright</varname></title>
- <para>
- Required line based list: one or more free-form copyright
- statement(s), one per line, that apply to the files matched by the
- above pattern. If a work has no copyright holder (i.e., it is in
- the public domain), that information should be recorded here.
- </para>
- <para>
- The <varname>Copyright</varname> field collects all relevant copyright
- notices for the files of this paragraph. Not all copyright notices
- may apply to every individual file, and years of publication for one
- copyright holder may be gathered together. For example, if file A
- has:
-<programlisting>Copyright 2008 John Smith
-Copyright 2009 Angela Watts</programlisting>
- and file B has:
-<programlisting>Copyright 2010 Angela Watts</programlisting>
- the <varname>Copyright</varname> field for a stanza
- covering both file A and file B need contain only:
-<programlisting>Copyright 2008 John Smith
-Copyright 2009, 2010 Angela Watts</programlisting>
- </para>
- <para>
- The <varname>Copyright</varname> field may contain the original
- copyright statement copied exactly (including the word
- <quote>Copyright</quote>), or it can shorten the text, as long
- as it does not sacrifice information. Examples in this specification
- use both forms.
- </para>
- </section>
-
- <section id="license-files-field">
- <title><varname>License</varname></title>
- <para>
- Required formatted text, with synopsis: licensing terms for the files
- listed in <varname>Files</varname> field for this paragraph.
- </para>
- <para>
- First line: an abbreviated name for the license, or expression
- giving alternatives (see <link linkend="license-short-name">Short
- names</link> section for a list of standard abbreviations). If there
- are licenses present in the package without a standard short name, an
- arbitrary short name may be assigned for these licenses. These
- arbitrary names are only guaranteed to be unique within a single
- copyright file.
- </para>
- <para>
- Remaining lines: if left blank here, the file
- <emphasis>must</emphasis> include a stand-alone
- <varname>License</varname> paragraph matching each license short
- name listed on the first line (see the <link
- linkend="stand-alone-license-paragraph">Standalone License
- Paragraph</link> section). Otherwise, this field should either
- include the full text of the license(s) or include a pointer to the
- license file under <filename>/usr/share/common-licenses</filename>.
- This field should include all text needed in order to fulfill both
- Debian Policy's requirement for including a copy of the software's
- distribution license (<ulink
- url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>),
- and any license requirements to include warranty disclaimers or other
- notices with the binary package.
- </para>
- </section>
-
- <section id="comment-files-field">
- <title><varname>Comment</varname></title>
- <para>
- Same as the <link linkend="comment-header-field">
- <varname>Comment</varname></link> field in the header paragraph.
- </para>
- </section>
-
- <section id="example-files-paragraph">
- <title>Example files paragraphs</title>
-<programlisting>Files: *
-Copyright: 1975-2010 Ulla Upstream
-License: GPL-2+
-
-Files: debian/*
-Copyright: 2010 Daniela Debianizer
-License: GPL-2+
-
-Files: debian/patches/fancy-feature
-Copyright: 2010 Daniela Debianizer
-License: GPL-3+
-
-Files: */*.1
-Copyright: 2010 Manuela Manpager
-License: GPL-2+</programlisting>
- <para>
- In this example, all files are copyright by the upstream and licensed
- under the GPL, version 2 or later, with three exceptions. All the
- Debian packaging files are copyright by the packager, and further one
- specific file providing a new feature is licensed differently.
- Finally, there are some manual pages added to the package, written by
- a third person.
- </para>
- </section>
- </section>
-
- <section id="stand-alone-license-paragraph">
- <title>Standalone License Paragraph (Optional, Repeatable)</title>
- <para>
- Where a set of files are dual (tri, etc) licensed, or when the same
- license occurs multiple times, you can use a single line
- <varname>License</varname> field and standalone
- <varname>License</varname> paragraphs to expand the license short names.
- </para>
- <example>
- <title>tri-licensed files</title>
-<programlisting>Files: src/js/editline/*
-Copyright: 1993, John Doe
- 1993, Joe Average
-License: MPL-1.1 or GPL-2 or LGPL-2.1
-
-License: MPL-1.1
- [LICENSE TEXT]
-
-License: GPL-2
- [LICENSE TEXT]
-
-License: LGPL-2.1
- [LICENSE TEXT]</programlisting>
- </example>
-
- <example>
- <title>recurrent license</title>
-<programlisting>Files: src/js/editline/*
-Copyright: 1993, John Doe
- 1993, Joe Average
-License: MPL-1.1
-
-Files: src/js/fdlibm/*
-Copyright: 1993, J-Random Corporation
-License: MPL-1.1
-
-License: MPL-1.1
- [LICENSE TEXT]</programlisting>
- </example>
- </section>
+ </section>
+
</section>
-
<section id="license-specification">
<title>License specification</title>
Modified: web/deps/dep5/index.html
URL: http://svn.debian.org/wsvn/dep/web/deps/dep5/index.html?rev=233&op=diff
==============================================================================
--- web/deps/dep5/index.html (original)
+++ web/deps/dep5/index.html Tue Dec 13 18:33:58 2011
@@ -57,6 +57,8 @@
<dt><a href="#paragraphs">Paragraphs</a></dt>
+ <dt><a href="#fields">Fields</a></dt>
+
<dt><a href="#license-specification">License
specification</a></dt>
@@ -244,138 +246,62 @@
<h3 class="section"><a name="header-paragraph" id=
"header-paragraph">Header paragraph (Once)</a></h3>
- <div class="section">
- <h4 class="section"><a name="format-header-field" id=
- "format-header-field"><code class=
- "varname">Format</code></a></h4>
-
- <p>Required single line: URI of the format specification,
- such as: <tt class=
- "literal">http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</tt></p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="upstream-name-header-field"
- id="upstream-name-header-field"><code class=
- "varname">Upstream-Name</code></a></h4>
-
- <p>Optional single line: the name upstream uses for the
- software</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name=
- "upstream-contact-header-field" id=
- "upstream-contact-header-field"><code class=
- "varname">Upstream-Contact</code></a></h4>
-
- <p>Optional line based list: the preferred address(es) to
- reach the upstream project. May be free-form text, but by
- convention will usually be written as a list of RFC5322
- addresses or URIs.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="source-header-field" id=
- "source-header-field"><code class=
- "varname">Source</code></a></h4>
-
- <p>Optional formatted text, no synopsis: an explanation
- from where the upstream source came from. Typically this
- would be a URL, but it might be a free-form explanation.
- The Debian Policy section <a href=
- "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
- target="_top">12.5</a> requires this information unless
- there are no upstream sources, which is mainly the case
- for native Debian packages. If the upstream source has
- been modified to remove non-free parts, that should be
- explained in this field.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="disclaimer-header-field" id=
- "disclaimer-header-field"><code class=
- "varname">Disclaimer</code></a></h4>
-
- <p>Optional formatted text, no synopsis: this field can
- be used in the case of non-free and contrib packages (see
- <a href=
- "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
- target="_top">12.5</a>)</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="comment-header-field" id=
- "comment-header-field"><code class=
- "varname">Comment</code></a></h4>
-
- <p>Optional formatted text, no synopsis: this field can
- provide additional information. For example, it might
- quote an e-mail from upstream justifying why the license
- is acceptable to the main archive, or an explanation of
- how this version of the package has been forked from a
- version known to be DFSG-free, even though the current
- upstream version is not.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="license-header-field" id=
- "license-header-field"><code class=
- "varname">License</code></a></h4>
-
- <p>Optional formatted text, with synopsis: in the header
- paragraph (no <code class="varname">Files</code>
- specification), this field gives the license information
- for the package as a whole, which may be different or
- simplified from a combination of all the per-file license
- information. See also <code class=
- "varname">License</code> below in the <a href=
- "#files-paragraph">Files paragraph</a> section.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="copyright-header-field" id=
- "copyright-header-field"><code class=
- "varname">Copyright</code></a></h4>
-
- <p>Optional line based list: in the header paragraph (no
- <code class="varname">Files</code> specification), this
- field gives the copyright information for the package as
- a whole, which may be different or simplified from a
- combination of all the per-file copyright information.
- See also <code class="varname">Copyright</code> below in
- the <a href="#files-paragraph">Files paragraph</a>
- section.</p>
-
- <p>The <code class="varname">Copyright</code> and
- <code class="varname">License</code> fields in the
- <span class="emphasis"><i class="emphasis">header
- paragraph</i></span> may complement but do not replace
- the <span class="emphasis"><i class="emphasis">files
- paragraphs</i></span>. They can be used to summarise the
- contributions and redistribution terms for the whole
- package, for instance when a work combines a permissive
- and a copyleft license, or to document a <span class=
- "emphasis"><i class="emphasis">compilation
- copyright</i></span> and license. It is possible to use
- only <code class="varname">License</code> in the header
- paragraph, but <code class="varname">Copyright</code>
- alone makes no sense.</p>
- </div>
+ <p>The following fields may be present in a header
+ paragraph.</p>
+
+ <ul>
+ <li>
+ <p><a href="#format-field">Format</a>: required.</p>
+ </li>
+
+ <li>
+ <p><a href="#upstream-name-field">Upstream-Name</a>:
+ optional.</p>
+ </li>
+
+ <li>
+ <p><a href=
+ "#upstream-contact-field">Upstream-Contact</a>:
+ optional.</p>
+ </li>
+
+ <li>
+ <p><a href="#source-field">Source</a>: optional.</p>
+ </li>
+
+ <li>
+ <p><a href="#disclaimer-field">Disclaimer</a>:
+ optional.</p>
+ </li>
+
+ <li>
+ <p><a href="#comment-field">Comment</a>: optional.</p>
+ </li>
+
+ <li>
+ <p><a href="#license-field">License</a>: optional.</p>
+ </li>
+
+ <li>
+ <p><a href="#copyright-field">Copyright</a>:
+ optional.</p>
+ </li>
+ </ul>
+
+ <p>The <code class="varname">Copyright</code> and
+ <code class="varname">License</code> fields in the
+ <span class="emphasis"><i class="emphasis">header
+ paragraph</i></span> may complement but do not replace the
+ <span class="emphasis"><i class="emphasis">Files
+ paragraphs</i></span>. They can be used to summarise the
+ contributions and redistribution terms for the whole
+ package, for instance when a work combines a permissive and
+ a copyleft license, or to document a <span class=
+ "emphasis"><i class="emphasis">compilation
+ copyright</i></span> and license. It is possible to use
+ only <code class="varname">License</code> in the header
+ paragraph, but <code class="varname">Copyright</code> alone
+ makes no sense.</p>
<div class="section">
<hr>
@@ -403,184 +329,27 @@
single paragraph can be used which applies to all files and
lists all applicable copyrights and licenses.</p>
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="files-files-field" id=
- "files-files-field"><code class=
- "varname">Files</code></a></h4>
-
- <p>Required whitespace-separated list: list of patterns
- indicating files covered by the license and copyright
- specified in this paragraph.</p>
-
- <p>Filename patterns in the <code class=
- "varname">Files</code> field are specified using a
- simplified shell glob syntax. Patterns are separated by
- whitespace.</p>
-
- <ul>
- <li>
- <p>Only the wildcards <tt class="literal">*</tt> and
- <tt class="literal">?</tt> apply; the former matches
- any number of characters (including none), the latter
- a single character. Both match a slash (<tt class=
- "literal">/</tt>) and a leading dot.</p>
- </li>
-
- <li>
- <p>Patterns match pathnames that start at the root of
- the source tree. Thus, <span class=
- "QUOTE">"<tt class="filename">Makefile.in</tt>"</span>
- matches only the file at the root of the tree, but
- <span class="QUOTE">"<tt class=
- "filename">*/Makefile.in</tt>"</span> matches at any
- depth.</p>
- </li>
-
- <li>
- <p>The backslash (<tt class="literal">\</tt>) is used
- to remove the magic from the next character; see
- table below.</p>
- </li>
- </ul>
-
- <div class="informaltable">
- <a name="AEN145" id="AEN145"></a>
-
- <table border="1" class="CALSTABLE">
- <col>
- <col>
-
- <thead>
- <tr>
- <th>Escape sequence</th>
-
- <th>Matches</th>
- </tr>
- </thead>
-
- <tbody>
- <tr>
- <td><tt class="literal">\*</tt></td>
-
- <td>star (asterisk)</td>
- </tr>
-
- <tr>
- <td><tt class="literal">\?</tt></td>
-
- <td>question mark</td>
- </tr>
-
- <tr>
- <td><tt class="literal">\\</tt></td>
-
- <td>backslash</td>
- </tr>
- </tbody>
- </table>
- </div>Any other character following a backslash is an
- error.
-
- <p>Multiple <code class="varname">Files</code> paragraphs
- are allowed. The last paragraph that matches a particular
- file applies to it.</p>
-
- <p>Exclusions are done by having multiple <code class=
- "varname">Files</code> paragraphs.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="copyright-files-field" id=
- "copyright-files-field"><code class=
- "varname">Copyright</code></a></h4>
-
- <p>Required line based list: one or more free-form
- copyright statement(s), one per line, that apply to the
- files matched by the above pattern. If a work has no
- copyright holder (i.e., it is in the public domain), that
- information should be recorded here.</p>
-
- <p>The <code class="varname">Copyright</code> field
- collects all relevant copyright notices for the files of
- this paragraph. Not all copyright notices may apply to
- every individual file, and years of publication for one
- copyright holder may be gathered together. For example,
- if file A has:</p>
- <pre class="programlisting">
-Copyright 2008 John Smith
-Copyright 2009 Angela Watts
-</pre>and file B has:
- <pre class="programlisting">
-Copyright 2010 Angela Watts
-</pre>the <code class="varname">Copyright</code> field for a stanza
-covering both file A and file B need contain only:
- <pre class="programlisting">
-Copyright 2008 John Smith
-Copyright 2009, 2010 Angela Watts
-</pre>
-
- <p>The <code class="varname">Copyright</code> field may
- contain the original copyright statement copied exactly
- (including the word <span class=
- "QUOTE">"Copyright"</span>), or it can shorten the text,
- as long as it does not sacrifice information. Examples in
- this specification use both forms.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="license-files-field" id=
- "license-files-field"><code class=
- "varname">License</code></a></h4>
-
- <p>Required formatted text, with synopsis: licensing
- terms for the files listed in <code class=
- "varname">Files</code> field for this paragraph.</p>
-
- <p>First line: an abbreviated name for the license, or
- expression giving alternatives (see <a href=
- "#license-short-name">Short names</a> section for a list
- of standard abbreviations). If there are licenses present
- in the package without a standard short name, an
- arbitrary short name may be assigned for these licenses.
- These arbitrary names are only guaranteed to be unique
- within a single copyright file.</p>
-
- <p>Remaining lines: if left blank here, the file
- <span class="emphasis"><i class=
- "emphasis">must</i></span> include a stand-alone
- <code class="varname">License</code> paragraph matching
- each license short name listed on the first line (see the
- <a href="#stand-alone-license-paragraph">Standalone
- License Paragraph</a> section). Otherwise, this field
- should either include the full text of the license(s) or
- include a pointer to the license file under <tt class=
- "filename">/usr/share/common-licenses</tt>. This field
- should include all text needed in order to fulfill both
- Debian Policy's requirement for including a copy of the
- software's distribution license (<a href=
- "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
- target="_top">12.5</a>), and any license requirements to
- include warranty disclaimers or other notices with the
- binary package.</p>
- </div>
-
- <div class="section">
- <hr>
-
- <h4 class="section"><a name="comment-files-field" id=
- "comment-files-field"><code class=
- "varname">Comment</code></a></h4>
-
- <p>Same as the <a href="#comment-header-field">
- <code class="varname">Comment</code></a> field in the
- header paragraph.</p>
- </div>
+ <p>The following fields may be present in a Files
+ paragraph.</p>
+
+ <ul>
+ <li>
+ <p><a href="#files-field">Files</a>: required.</p>
+ </li>
+
+ <li>
+ <p><a href="#license-field">Copyright</a>:
+ required.</p>
+ </li>
+
+ <li>
+ <p><a href="#license-field">License</a>: required.</p>
+ </li>
+
+ <li>
+ <p><a href="#comment-field">Comment</a>: optional.</p>
+ </li>
+ </ul>
<div class="section">
<hr>
@@ -629,8 +398,21 @@
standalone <code class="varname">License</code> paragraphs
to expand the license short names.</p>
+ <p>The following fields may be present in a standalone
+ license paragraph.</p>
+
+ <ul>
+ <li>
+ <p><a href="#license-field">License</a>: required.</p>
+ </li>
+
+ <li>
+ <p><a href="#comment-field">Comment</a>: optional.</p>
+ </li>
+ </ul>
+
<div class="example">
- <a name="AEN209" id="AEN209"></a>
+ <a name="AEN140" id="AEN140"></a>
<p><b>Example 1. tri-licensed files</b></p>
<pre class="programlisting">
@@ -651,7 +433,7 @@
</div>
<div class="example">
- <a name="AEN212" id="AEN212"></a>
+ <a name="AEN143" id="AEN143"></a>
<p><b>Example 2. recurrent license</b></p>
<pre class="programlisting">
@@ -668,6 +450,276 @@
[LICENSE TEXT]
</pre>
</div>
+ </div>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h2 class="section"><a name="fields" id=
+ "fields">Fields</a></h2>
+
+ <p>The following fields are defined for use in <tt class=
+ "filename">debian/copyright</tt>.</p>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="format-field" id=
+ "format-field"><code class="varname">Format</code></a></h3>
+
+ <p>Single-line: URI of the format specification, such as:
+ <tt class=
+ "literal">http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</tt>.
+ Required in <a href="#header-paragraph">header
+ paragraphs</a>.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="upstream-name-field" id=
+ "upstream-name-field"><code class=
+ "varname">Upstream-Name</code></a></h3>
+
+ <p>Single-line: the name upstream uses for the software</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="upstream-contact-field" id=
+ "upstream-contact-field"><code class=
+ "varname">Upstream-Contact</code></a></h3>
+
+ <p>Line-based list: the preferred address(es) to reach the
+ upstream project. May be free-form text, but by convention
+ will usually be written as a list of RFC5322 addresses or
+ URIs.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="source-field" id=
+ "source-field"><code class="varname">Source</code></a></h3>
+
+ <p>Formatted text, no synopsis: an explanation from where
+ the upstream source came from. Typically this would be a
+ URL, but it might be a free-form explanation. The Debian
+ Policy section <a href=
+ "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
+ target="_top">12.5</a> requires this information unless
+ there are no upstream sources, which is mainly the case for
+ native Debian packages. If the upstream source has been
+ modified to remove non-free parts, that should be explained
+ in this field.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="disclaimer-field" id=
+ "disclaimer-field"><code class=
+ "varname">Disclaimer</code></a></h3>
+
+ <p>Formatted text, no synopsis: this field can be used in
+ the case of non-free and contrib packages (see <a href=
+ "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
+ target="_top">12.5</a>).</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="comment-field" id=
+ "comment-field"><code class=
+ "varname">Comment</code></a></h3>
+
+ <p>Formatted text, no synopsis: this field can provide
+ additional information. For example, it might quote an
+ e-mail from upstream justifying why the license is
+ acceptable to the main archive, or an explanation of how
+ this version of the package has been forked from a version
+ known to be DFSG-free, even though the current upstream
+ version is not.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="license-field" id=
+ "license-field"><code class=
+ "varname">License</code></a></h3>
+
+ <p>Formatted text, with synopsis. In the header paragraph,
+ this field gives the license information for the package as
+ a whole, which may be different or simplified from a
+ combination of all the per-file license information. In a
+ Files paragraph, this field gives the licensing terms for
+ the files listed in the <code class="varname">Files</code>
+ field for this paragraph. In a stand-alone license
+ paragraph, it gives the licensing terms for those
+ paragraphs which reference it.</p>
+
+ <p>First line: an abbreviated name for the license, or
+ expression giving alternatives (see <a href=
+ "#license-short-name">Short names</a> section for a list of
+ standard abbreviations). If there are licenses present in
+ the package without a standard short name, an arbitrary
+ short name may be assigned for these licenses. These
+ arbitrary names are only guaranteed to be unique within a
+ single copyright file.</p>
+
+ <p>Remaining lines: if left blank here, the file
+ <span class="emphasis"><i class="emphasis">must</i></span>
+ include a stand-alone <code class="varname">License</code>
+ paragraph matching each license short name listed on the
+ first line (see the <a href=
+ "#stand-alone-license-paragraph">Standalone License
+ Paragraph</a> section). Otherwise, this field should either
+ include the full text of the license(s) or include a
+ pointer to the license file under <tt class=
+ "filename">/usr/share/common-licenses</tt>. This field
+ should include all text needed in order to fulfill both
+ Debian Policy's requirement for including a copy of the
+ software's distribution license (<a href=
+ "http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile"
+ target="_top">12.5</a>), and any license requirements to
+ include warranty disclaimers or other notices with the
+ binary package.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="copyright-field" id=
+ "copyright-field"><code class=
+ "varname">Copyright</code></a></h3>
+
+ <p>Line-based list: one or more free-form copyright
+ statement(s), one per line. In the header paragraph, this
+ field gives the copyright information for the package as a
+ whole, which may be different or simplified from a
+ combination of all the per-file copyright information. In
+ the Files paragraphs, it gives the copyright information
+ that applies to the files matched by the <code class=
+ "varname">Files</code> pattern. If a work has no copyright
+ holder (i.e., it is in the public domain), that information
+ should be recorded here.</p>
+
+ <p>The <code class="varname">Copyright</code> field
+ collects all relevant copyright notices for the files of
+ this paragraph. Not all copyright notices may apply to
+ every individual file, and years of publication for one
+ copyright holder may be gathered together. For example, if
+ file A has:</p>
+ <pre class="programlisting">
+Copyright 2008 John Smith
+Copyright 2009 Angela Watts
+</pre>and file B has:
+ <pre class="programlisting">
+Copyright 2010 Angela Watts
+</pre>the <code class="varname">Copyright</code> field for a stanza
+covering both file A and file B need contain only:
+ <pre class="programlisting">
+Copyright 2008 John Smith
+Copyright 2009, 2010 Angela Watts
+</pre>
+
+ <p>The <code class="varname">Copyright</code> field may
+ contain the original copyright statement copied exactly
+ (including the word <span class=
+ "QUOTE">"Copyright"</span>), or it can shorten the text, as
+ long as it does not sacrifice information. Examples in this
+ specification use both forms.</p>
+ </div>
+
+ <div class="section">
+ <hr>
+
+ <h3 class="section"><a name="files-field" id=
+ "files-field"><code class="varname">Files</code></a></h3>
+
+ <p>Whitespace-separated list: list of patterns indicating
+ files covered by the license and copyright specified in
+ this paragraph.</p>
+
+ <p>Filename patterns in the <code class=
+ "varname">Files</code> field are specified using a
+ simplified shell glob syntax. Patterns are separated by
+ whitespace.</p>
+
+ <ul>
+ <li>
+ <p>Only the wildcards <tt class="literal">*</tt> and
+ <tt class="literal">?</tt> apply; the former matches
+ any number of characters (including none), the latter a
+ single character. Both match a slash (<tt class=
+ "literal">/</tt>) and a leading dot.</p>
+ </li>
+
+ <li>
+ <p>Patterns match pathnames that start at the root of
+ the source tree. Thus, <span class="QUOTE">"<tt class=
+ "filename">Makefile.in</tt>"</span> matches only the
+ file at the root of the tree, but <span class=
+ "QUOTE">"<tt class=
+ "filename">*/Makefile.in</tt>"</span> matches at any
+ depth.</p>
+ </li>
+
+ <li>
+ <p>The backslash (<tt class="literal">\</tt>) is used
+ to remove the magic from the next character; see table
+ below.</p>
+ </li>
+ </ul>
+
+ <div class="informaltable">
+ <a name="AEN226" id="AEN226"></a>
+
+ <table border="1" class="CALSTABLE">
+ <col>
+ <col>
+
+ <thead>
+ <tr>
+ <th>Escape sequence</th>
+
+ <th>Matches</th>
+ </tr>
+ </thead>
+
+ <tbody>
+ <tr>
+ <td><tt class="literal">\*</tt></td>
+
+ <td>star (asterisk)</td>
+ </tr>
+
+ <tr>
+ <td><tt class="literal">\?</tt></td>
+
+ <td>question mark</td>
+ </tr>
+
+ <tr>
+ <td><tt class="literal">\\</tt></td>
+
+ <td>backslash</td>
+ </tr>
+ </tbody>
+ </table>
+ </div>Any other character following a backslash is an
+ error.
+
+ <p>Multiple <code class="varname">Files</code> paragraphs
+ are allowed. The last paragraph that matches a particular
+ file applies to it.</p>
+
+ <p>Exclusions are done by having multiple <code class=
+ "varname">Files</code> paragraphs.</p>
</div>
</div>
@@ -732,7 +784,7 @@
"_top">SPDX Open Source License Registry</a>.</p>
<div class="informaltable">
- <a name="AEN237" id="AEN237"></a>
+ <a name="AEN271" id="AEN271"></a>
<table border="1" class="CALSTABLE">
<col>
@@ -1273,7 +1325,7 @@
"examples">Examples</a></h2>
<div class="example">
- <a name="AEN466" id="AEN466"></a>
+ <a name="AEN500" id="AEN500"></a>
<p><b>Example 3. Simple</b></p>
@@ -1318,7 +1370,7 @@
</div>
<div class="example">
- <a name="AEN473" id="AEN473"></a>
+ <a name="AEN507" id="AEN507"></a>
<p><b>Example 4. Complex</b></p>
More information about the dep-commits
mailing list