Simon McVittie <[email protected]> writes:

> On Mon, 16 Mar 2026 at 08:01:12 +0100, Lucas Nussbaum wrote:
>>On 16/03/26 at 00:23 +0100, kpcyrd wrote:
>>> > 720 - archive tarball fully included in generated tarball
>>>
>>> This is "normal" when excluding files that can't be uploaded to Debian,
>>> maybe this should be yellow instead of red?
>>>
>>> https://debaudit.debian.net/upstream2orig/result/c588756e9a693dc423bacd81fa8f2cf6d6f13af442836747f391267f3d28f717
>>
>>It means that the exclusion of such files is not properly automated in
>>debian/watch or debian/copyright, but instead done manually(?)
>
> 7zip also makes a good example of how this can be automated:
> <https://tracker.debian.org/media/packages/7/7zip/copyright-25.01dfsg-1deb13u1>
> has "Files-Excluded: CPP/7zip/Compress/Rar*", which is both
> documentation of what was done to the upstream tarball to arrive at
> the +dfsg tarball, and a machine-readable instruction for uscan to do
> it again next time a new upstream version is imported.

Sadly this feature is poorly documented.

Any objections to mention Files-Excluded[-*] and Files-Included in DEP5?

https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

I think a pointer to the following documentation would be sufficient:

https://manpages.debian.org/testing/devscripts/uscan.1.en.html#COPYRIGHT_FILE_EXAMPLES
https://manpages.debian.org/testing/devscripts/mk-origtargz.1.en.html

How about something like the attached patch?

https://salsa.debian.org/jas/policy/-/commit/b88284ddc08dbe8ee93462f6f8c667611b4d778e

/Simon
From b88284ddc08dbe8ee93462f6f8c667611b4d778e Mon Sep 17 00:00:00 2001
From: Simon Josefsson <[email protected]>
Date: Mon, 16 Mar 2026 11:01:42 +0100
Subject: [PATCH] Mention Files-Excluded/Included in copyright-format

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

diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index 954a65b..205bc44 100644
--- a/copyright-format-1.0.xml
+++ b/copyright-format-1.0.xml
@@ -246,6 +246,11 @@
             <link linkend="copyright-field">Copyright</link>: optional.
           </para>
         </listitem>
+        <listitem>
+          <para>
+            <link linkend="files-excluded-field">Files-Excluded, Files-Excluded-*, Files-Included</link>: optional.
+          </para>
+        </listitem>
       </itemizedlist>
       <para>
         The <varname>Copyright</varname> and <varname>License</varname>
@@ -498,6 +503,18 @@ License: MPL-1.1
       </para>
     </section>
 
+    <section id="files-excluded-field">
+      <title><varname>Files-Excluded, Files-Excluded-*, Files-Included</varname></title>
+      <para>
+        Formatted text, no synopsis: this field is used by <ulink
+        url="https://manpages.debian.org/testing/devscripts/uscan.1.en.html#COPYRIGHT_FILE_EXAMPLES";>uscan</ulink>
+        and <ulink
+        url="https://manpages.debian.org/testing/devscripts/mk-origtargz.1.en.html";>mk-origtargz</ulink>
+        to automatically repack an upstream tarball, see the
+        documentation for details.
+      </para>
+    </section>
+
     <section id="license-field">
       <title><varname>License</varname></title>
       <para>
-- 
2.52.0

Attachment: signature.asc
Description: PGP signature

Reply via email to