Hello again,
On Mon, Oct 26, 2020 at 03:14:02PM -0700, Sean Whitton wrote:
> Hello,
>
> On Sun 25 Oct 2020 at 09:40PM -04, Joe Nahmias wrote:
>
> > Is this truly the case that all that's needed is a new patch? Can we get
> > an official ACK from one of the policy editors? I'd be happy to re-write
> > the original patch to apply against HEAD if that's all that is required.
>
> Well, it would need seconding, but otherwise, ACK.
>
> Thank you for your interest.
Well, it took me longer than I anticipated to get around to this; nevertheless,
below is my first draft at a patch to document Files-Excluded. It's my first
time writing for Debian Policy, so please let me know if I didn't use an
appropriate convention somewhere.
--Joe
---
copyright-format-1.0.xml | 52 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/copyright-format-1.0.xml b/copyright-format-1.0.xml
index b8df359..102b7fa 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</link>: optional.
+ </para>
+ </listitem>
</itemizedlist>
<para>
The <varname>Copyright</varname> and <varname>License</varname>
@@ -672,6 +677,53 @@ Copyright 2009, 2010 Angela Watts</programlisting>
</para>
</section>
+ <section id="files-excluded-field">
+ <title><varname>Files-Excluded</varname></title>
+ <para>
+ Whitespace-separated list: list of patterns indicating files that have
+ been removed from the original upstream source distribution. The
+ syntax for the patterns describing these files is identical to that
+ of the <varname><link linkend="files-field">Files</link></varname>
+ field.
+ </para>
+ <para>
+ Often upstream developers include additional files in their source
+ distribution files that are unwanted by Debian and/or unneeded for
+ use in building a Debian package, such as:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Source files that do not meet the DFSG;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Pre-compiled executable binary or other non human-editable files;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Files intended for use with other platforms.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ These types of files, or any others that Debian does not want to
+ include in our archive, must be stripped from the upstream tarball
+ prior to uploading. The <varname>Files-Excluded</varname> field serves
+ to document the removal of these files from the original upstream
+ source. This allows others to understand or audit how the source
+ distribution in Debian is derived from the upstream source.
+ </para>
+ <para>
+ Additionally, once documented in this manner, various tools such as
+ <literal>uscan</literal> or <literal>mk-origtargz</literal> can use
+ this information as instructions on how to automatically repack an
+ upstream source distribution into one suitable for use within Debian.
+ </para>
+ </section>
+
</section>
<section id="license-specification">
<title>License specification</title>
Attachment:
signature.asc
Description: PGP signature