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

[DEP5] Clarification of the minimum required structure



Hello,

Currently the DEP5 draft includes the following text:

  The Copyright and License fields in the header paragraph may complement
  but do not replace the files paragraphs.

This implies, but does not state explicitly, that there must be at least one
Files paragraph in the file to be compliant.  I would like to see this
corrected by making it explicit in the section on File syntax what the
minimum required structure is; but it's possible others have a different
understanding of this text.

Is the attached patch ok to commit?

-- 
Steve Langasek                   Give me a lever long enough and a Free OS
Debian Developer                   to set it on, and I can move the world.
Ubuntu Developer                                    http://www.debian.org/
slangasek@ubuntu.com                                     vorlon@debian.org
=== modified file 'dep5/copyright-format.xml'
--- old/dep5/copyright-format.xml	2011-12-12 07:48:31 +0000
+++ new/dep5/copyright-format.xml	2011-12-12 08:01:32 +0000
@@ -118,6 +118,12 @@
       avoid conflicting specifications for widely used extra fields.
     </para>
     <para>
+      The file consists of two or more paragraphs.  At minimum, the file
+      must include one <link linkend="header-paragraph">header
+      paragraph</link> and one <link linkend="files-paragraph">Files
+      paragraph</link>.
+    </para>
+    <para>
       There are four kinds values for fields.  Each field specifies which kind
       is allowed.
     </para>

Attachment: signature.asc
Description: Digital signature


Reply to: