Document ALWAYS_KEEP_DISTFILES which was added to comply with the GPLs

distribution clause when using binary distfiles, which requires
that the source code for the binary distfiles is provided as well.

Reviewed by:	simon
This commit is contained in:
Erwin Lansing 2006-01-17 18:55:31 +00:00
parent e784483a0b
commit 3e3869af11
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=26864

View file

@ -2997,6 +2997,29 @@ PATCHFILES= patch1:test</programlisting>
define in your <filename>Makefile</filename>.</para>
</note>
</sect2>
<sect2>
<title><makevar>ALWAYS_KEEP_DISTFILES</makevar></title>
<para>If your port uses binary distfiles and has a license that
requires that the source code is provided with packages distributed
in binary form, e.g. GPL, <makevar>ALWAYS_KEEP_DISTFILES</makevar>
will instruct the &os; build cluster to keep a copy of the files
specified in <makevar>DISTFILES</makevar>. Users of these ports
will generally not need these files, so it is a good idea to only
add the source distfiles to <makevar>DISTFILES</makevar> when
<makevar>PACKAGE_BUILDING</makevar> is defined.
</para>
<example
id="ports-master-sites-n-example-always-keep-distfiles">
<title>Use of <makevar>ALWAYS_KEEP_DISTFILES</makevar>.</title>
<programlisting>.if defined(PACKAGE_BUILDING)
DISTFILES+= <replaceable>foo.tar.gz</replaceable>
ALWAYS_KEEP_DISTFILES= yes
.endif</programlisting>
</example>
</sect2>
</sect1>
<sect1 id="makefile-maintainer">