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

Bug#874090: marked as done (debian-policy: Clarify wording of some passages)

Your message dated Wed, 27 Dec 2017 22:48:45 +0000
with message-id <E1eUKVB-000Dqz-EQ@fasolo.debian.org>
and subject line Bug#874090: fixed in debian-policy 4.1.3.0
has caused the Debian Bug report #874090,
regarding debian-policy: Clarify wording of some passages
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
874090: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=874090
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: debian-policy
Version: 4.1.0.0
Severity: minor
Tags: patch

Howdy all,

I have made some minor clarifying changes while working on another bug
report.

These changes do not have any substantive effect on the intended
meaning of the passages, only to clarity of expression.

The output of ‘git request-pull’ for these changes:

=====
The following changes since commit b9684c285afd148b102fc76f566175712cbfacac:

  in Testsuite:, add hints to explain some terminology (2017-09-02 08:25:56 -0700)

are available in the git repository at:

  bignose@git.debian.org:public_git/debian-full/debian-policy.git wip/maintenance/wording-clarifications

for you to fetch changes up to 1bf68292ff9f8617a79d974a54a9e58372644d3e:

  Clarify a potential contradiction in which files have what license. (2017-09-03 14:24:36 +1000)

----------------------------------------------------------------
(from the branch description for wip/maintenance/wording-clarifications local branch)

Clarify and re-word some passages.

----------------------------------------------------------------
Ben Finney (6):
      Separate some longer passages into paragraphs.
      Link terms to their definitions.
      Clarify “makes no sense” by instead stating why it is not acceptable.
      Correct reference specifically to fields in a paragraph.
      Use tighter phrasing of copyright holders and license grant.
      Clarify a potential contradiction in which files have what license.

 copyright-format-1.0.xml | 117 ++++++++++++++++++++++++++++-------------------
 1 file changed, 69 insertions(+), 48 deletions(-)
=====

-- 
 \       “I have a map of the United States; it's actual size. It says |
  `\        ‘1 mile equals 1 mile’. Last summer, I folded it.” —Steven |
_o__)                                                           Wright |
Ben Finney <bignose@debian.org>

From 06a043b3c8edf7765d3dc9b469aed8d467e0cfbb Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:23:55 +1000
Subject: [PATCH 1/6] Separate some longer passages into paragraphs.

---
 copyright-format-1.0.xml | 91 ++++++++++++++++++++++++++++--------------------
 1 file changed, 54 insertions(+), 37 deletions(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index 2eef301b..e40a710a 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -167,12 +167,16 @@
       <para>
         Formatted text fields use the same rules as the long description
         in a package's <varname>Description</varname> field in Debian
-        control files.  In some but not all cases, the first line may have
-        special meaning as a synopsis, similar to how the
-        <varname>Description</varname> field uses the first line for the
-        short description. See Debian Policy's section 5.6.13, <ulink
+        control files.
+      </para>
+      <para>
+        In some but not all cases, the first line may have special
+        meaning as a synopsis, similar to how the
+        <varname>Description</varname> field uses the first line for
+        the short description. See Debian Policy's section 5.6.13,
+        <ulink
         url="https://www.debian.org/doc/debian-policy/ch-controlfields#s-f-Description";><quote>Description</quote></ulink>,
-        for details.  For example, <varname>Disclaimer</varname> is a
+        for details. For example, <varname>Disclaimer</varname> is a
         formatted text field that has no special first line, and
         <varname>License</varname> is a formatted text field where the
         first line indicates the short name or names of the licenses.
@@ -246,16 +250,22 @@
       <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>.  If
+        but do not replace the <emphasis>Files paragraphs</emphasis>. If
         present, they summarise the copyright notices or redistribution
-        terms for the package as a whole.  For example, when a work
-        combines a permissive and a copyleft license,
-        <varname>License</varname> can be used to clarify the license
-        terms for the combination.  <varname>Copyright</varname> and
-        <varname>License</varname> together can also be used 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.
+        terms for the package as a whole.
+      </para>
+      <para>
+        For example, when a work has a grant of license under both a
+        permissive and a copyleft license, <varname>License</varname> can
+        be used to clarify the license terms for the combination.
+        <varname>Copyright</varname> and <varname>License</varname>
+        together can also be used to document a <emphasis>compilation
+        copyright</emphasis> and license.
+      </para>
+      <para>
+        It is valid to use <varname>License</varname> in the header
+        paragraph without an accompanying <varname>Copyright</varname>
+        field, but <varname>Copyright</varname> alone makes no sense.
       </para>
 
       <section id="example-header-paragraph">
@@ -320,7 +330,8 @@ License: GPL-3+
 
 Files: */*.1
 Copyright: 2010 Manuela Manpager
-License: GPL-2+</programlisting>
+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
@@ -346,8 +357,11 @@ License: GPL-2+</programlisting>
       <para>
         Stand-alone <varname>License</varname> paragraphs can be used to
         provide the full license text for a given license once, instead of
-        repeating it in each <varname>Files</varname> paragraph that refers to
-        it.  The first line of the <varname>License</varname> field must be a
+        repeating it in each <varname>Files</varname> paragraph that refers
+        to it.
+      </para>
+      <para>
+        The first line of the <varname>License</varname> field must be a
         single license short name or a short name followed by a license
         exception.
       </para>
@@ -481,32 +495,35 @@ License: MPL-1.1
     <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.
+        Formatted text, with synopsis.
+      </para>
+      <para>
+        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 the <link linkend="license-short-name">Short
-        name</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.
+        giving alternatives (see the <link
+        linkend="license-short-name">Short name</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>
-        If there are no remaining lines, then all of the short names
-        or short names followed by license exceptions making up the
-        first line must be described in <link
+        If there are no remaining lines, then all of the short names or
+        short names followed by license exceptions making up the first line
+        must be described in <link
         linkend="stand-alone-license-paragraph">stand-alone License
-        paragraphs</link>.  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
+        paragraphs</link>. 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="https://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile";>12.5</ulink>),
-- 
2.14.1


From 502f7f4505cdb6a9de1194ef94d707f671a995dc Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:24:04 +1000
Subject: [PATCH 2/6] Link terms to their definitions.

---
 copyright-format-1.0.xml | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index e40a710a..aed6067a 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -498,13 +498,16 @@ License: MPL-1.1
         Formatted text, with synopsis.
       </para>
       <para>
-        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.
+        In the <link linkend="header-paragraph">header paragraph</link>,
+        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 <link
+        linkend="files-paragraph">Files paragraph</link>, this field gives
+        the licensing terms for the files listed in the
+        <varname>Files</varname> field for this paragraph. In a <link
+        linkend="stand-alone-license-paragraph">stand-alone License
+        paragraph</link>, it gives the licensing terms for those paragraphs
+        which reference it.
       </para>
       <para>
         First line: an abbreviated name for the license, or expression
-- 
2.14.1


From 86f3be7c4c16dd490160e2a28db6ceb89ea42e50 Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:24:13 +1000
Subject: [PATCH 3/6] =?UTF-8?q?Clarify=20=E2=80=9Cmakes=20no=20sense?=
 =?UTF-8?q?=E2=80=9D=20by=20instead=20stating=20why=20it=20is=20not=20acce?=
 =?UTF-8?q?ptable.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 copyright-format-1.0.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index aed6067a..2033825a 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -265,7 +265,7 @@
       <para>
         It is valid to use <varname>License</varname> in the header
         paragraph without an accompanying <varname>Copyright</varname>
-        field, but <varname>Copyright</varname> alone makes no sense.
+        field, but <varname>Copyright</varname> alone is not sufficient.
       </para>
 
       <section id="example-header-paragraph">
-- 
2.14.1


From 6c740ee16836f046a1156242022e88666eb99b5b Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:24:20 +1000
Subject: [PATCH 4/6] Correct reference specifically to fields in a paragraph.

---
 copyright-format-1.0.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index 2033825a..f1900944 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -250,9 +250,9 @@
       <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>. If
-        present, they summarise the copyright notices or redistribution
-        terms for the package as a whole.
+        but do not replace the fields in the <emphasis>Files
+        paragraphs</emphasis>. If present, they summarise the copyright
+        notices or redistribution terms for the package as a whole.
       </para>
       <para>
         For example, when a work has a grant of license under both a
-- 
2.14.1


From 8c0e804176f71c731fe9febeb8eb04a77d79d0db Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:24:29 +1000
Subject: [PATCH 5/6] Use tighter phrasing of copyright holders and license
 grant.

---
 copyright-format-1.0.xml | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index f1900944..848e8d67 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -333,12 +333,13 @@ 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.
+          In this example, copyright in all files is held by the upstream,
+          and that copyright holder grants license under the GPL, version 2
+          or later. There are three exceptions. All the Debian packaging
+          files have copyright held by the packager, and further one
+          specific file providing a new feature has a different grant of
+          license. Finally, there are some manual pages added to the
+          package, with copyright held by a third person.
         </para>
         <para>
           Since the license of the manual pages is the same as the other
-- 
2.14.1


From 1bf68292ff9f8617a79d974a54a9e58372644d3e Mon Sep 17 00:00:00 2001
From: Ben Finney <bignose@debian.org>
Date: Sun, 3 Sep 2017 14:24:36 +1000
Subject: [PATCH 6/6] Clarify a potential contradiction in which files have
 what license.

---
 copyright-format-1.0.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index 848e8d67..ceeacfdb 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -342,11 +342,11 @@ License: GPL-2+
           package, with copyright held by a third person.
         </para>
         <para>
-          Since the license of the manual pages is the same as the other
-          files in the package, the last paragraph above could instead be
+          Since the license of the manual pages is the same as most other
+          files in the package, the final paragraph above could instead be
           combined with the first paragraph, listing both copyright
-          statements in one <varname>Copyright</varname> field.  Whether
-          to combine paragraphs with the same license is left to the
+          statements in one <varname>Copyright</varname> field. Whether to
+          combine paragraphs with the same grant of license is left to the
           discretion of the author of the
           <filename>debian/copyright</filename> file.
         </para>
-- 
2.14.1

Attachment: signature.asc
Description: PGP signature


--- End Message ---
--- Begin Message --- 
Source: debian-policy
Source-Version: 4.1.3.0

We believe that the bug you reported is fixed in the latest version of
debian-policy, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 874090@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Sean Whitton <spwhitton@spwhitton.name> (supplier of updated debian-policy package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Wed, 27 Dec 2017 22:13:55 +0000
Source: debian-policy
Binary: debian-policy
Architecture: all source
Version: 4.1.3.0
Distribution: unstable
Urgency: medium
Maintainer: Debian Policy Editors <debian-policy@lists.debian.org>
Changed-By: Sean Whitton <spwhitton@spwhitton.name>
Closes: 522163 601455 661496 688251 810381 859649 874090 874095 880992 882628 885219
Description: 
 debian-policy - Debian Policy Manual and related documents
Changes:
 debian-policy (4.1.3.0) unstable; urgency=medium
 .
   [ Sean Whitton ]
   * Policy: Add CC0-1.0 to common-licenses
     Wording: Jeremy Bicha <jbicha@debian.org>
     Seconded: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Mattia Rizzolo <mattia@debian.org>
     Seconded: Holger Levsen <holger@layer-acht.org>
     Closes: #859649, #882628
   * Policy: Clarify when Built-Using should be used
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Russ Allbery <rra@debian.org>
     Seconded: Jonathan Nieder <jrnieder@gmail.com>
     Closes: #688251
   * Policy: Use update-rc.d's defaults-disabled instead of DISABLED=yes
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Wording: Russ Allbery <rra@debian.org>
     Seconded: Andreas Henriksson <andreas@fatal.se>
     Closes: #522163, #601455, #661496
     - Also explain how the local administrator can enable/disable
       autostarting daemons using update-rc.d.
   * Point Vcs-* fields at salsa.debian.org.
   * README: update references & URIs alioth->salsa
   * Maintainer field: "Debian Policy List"->"Debian Policy Editors"
     To match our new group on salsa.debian.org.
 .
   [ Russ Allbery ]
   * Policy: Recommend that Vcs-* URLs provide confidentiality
     Wording: Russ Allbery <rra@debian.org>
     Seconded: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Holger Levsen <holger@layer-acht.org>
     Closes: #810381
   * Policy: Clarify that programs may search PATH for editor and pager
     Wording: Jonathan Nieder <jrnieder@gmail.com>
     Seconded: Russ Allbery <rra@debian.org>
     Seconded: Sean Whitton <spwhitton@spwhitton.name>
     Closes: #880992
   * Policy: Allow libc to install files in /lib64
     Wording: Russ Allbery <rra@debian.org>
     Seconded: Jonathan Nieder <jrnieder@gmail.com>
     Seconded: Sean Whitton <spwhitton@spwhitton.name>
     Closes: #885219
   * Use the term synopsis consistently in copyright-format.  Thanks, Ben
     Finney.  (Closes: #874095)
   * Fix various minor wording issues and add additional cross-references
     in copyright-format.  Thanks, Ben Finney.  (Closes: #874090)
   * Adapt tools/license-count to run against ftp-master metadata instead
     of the Lintian lab, add patterns for CC0-1.0, and add some comments on
     how to run this tool.
Checksums-Sha1: 
 05da4159044b00745b08eb6eaab3e16cd05642c8 2001 debian-policy_4.1.3.0.dsc
 8d35cfc5a8c863e523ba6e02f9f2de7c5d5b9d89 676216 debian-policy_4.1.3.0.tar.xz
 f1ed62eac9c6f4fbccebc5898d927766d7f8dc01 2382244 debian-policy_4.1.3.0_all.deb
 9204463a0c2bae0737a4e1183214881006cfe974 11982 debian-policy_4.1.3.0_i386.buildinfo
Checksums-Sha256: 
 46e2da6bad32531018dece9414071cdb1ca6f541202e98b10b995917ab63b4de 2001 debian-policy_4.1.3.0.dsc
 343a6c8780cfad8444bdeae14a00464e5e8689f1d783cf49178f119346db3297 676216 debian-policy_4.1.3.0.tar.xz
 66636457413c145e6a9aba668ef6ef53fbcf86e6710df3318c7df181210e68da 2382244 debian-policy_4.1.3.0_all.deb
 586de7588896f56fba1c5fc7606c2a312d248e847a61e9a1a64d12fe4807f922 11982 debian-policy_4.1.3.0_i386.buildinfo
Files: 
 f75b8b0b837ff21a4c3e3842a77832c8 2001 doc optional debian-policy_4.1.3.0.dsc
 6b69ec9a8da76f26b7f1c61a27affd16 676216 doc optional debian-policy_4.1.3.0.tar.xz
 384e5f5082a6dc97e353dad48e726a8a 2382244 doc optional debian-policy_4.1.3.0_all.deb
 67ca8cc09b64aebfbc01ed7052d3c215 11982 doc optional debian-policy_4.1.3.0_i386.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAlpEHugACgkQaVt65L8G
YkBPMRAApf/ITvRdrBcV1oEx3OW7eWVFYr2bB+V7a5u5+MOhRFrgpalhz6OMt2hq
DksckEqJz4GOXjBj/ZlRI5a8VNtmgPwuLsY8MrlsWC9DyPmu6lPX+/HrDMnXmnR3
okXW+2ql7wdjuxBF92/WQJ4TkFHpzZcV7/o/FqDoBXw/29fMACtpZB8L5FPFkW/c
nfzMfIXmfKIi/RxQQEPnkaQ8VWHCdNkfRU6XB+qvuM/prpXEjdBtDHX/JfsNL45J
Mh+3kdo+rIvLGN1wg/+FI35eF22r9mNFlGLm1Hd01ywY2a310ubKCGd+0TDOxPfc
2u4UMaoqcQtfgT5+UzxjvYBfFO/7H02iXE9EvnaPBTmFbPHbd3YLpGTnSmguEUu6
7ABkZXibSzcptJ7iRrprtFTIXGvzB0UtMChKSGEQzk9/yj7VTFyEFH/berx8diwM
w4EqaMrSGQGN1m9Ot/CYd1DWqahZkFuLg/0eCJV3oqZBIGjSBmvwxhTTsrvikMdR
9tOU/DCGZKFGJLc1BDv4B56auDDEuvu1Yt3OEXe7JbDvzpqF1qackV37/ge1vc8d
L5WXM2NWfhh3L+PnMnRwYTxccACIwM8OGT/XpAI/Jzc3HEU4u03/Iu+UuyvxHbru
z5HgB7db1r2jPLinv9FFfpS8j443VbPx/LJua6RpJ1WpBeTymPw=
=Vzmq
-----END PGP SIGNATURE-----

--- End Message ---
Reply to: