Attachment #136032 for bug #181080




	<para>Of course, <makevar>PLIST_DIRS</makevar> should be left
	  unset if a port installs no directories of its own.</para>

	<note>
	  <para>It is possible that several ports share a common
	    directory. In that case
	    <makevar>PLIST_DIRS</makevar> should be replaced by
	    <makevar>PLIST_DIRSTRY</makevar> so that the directory
	    is removed only if empty, otherwise it is silently
	    ignored. <makevar>PLIST_DIRS</makevar> and
	    <makevar>PLIST_DIRSTRY</makevar> are equivalent to
	    using <literal>@dirrm</literal> and
	    <literal>@dirrmtry</literal> in
	    <filename>pkg-plist</filename>, which are described in
	    <xref linkend="plist-dir-cleaning"/>.</para>
	</note>

	<para>The price for this way of listing port's files and
	  directories is that you cannot use command sequences
	  described in &man.pkg.create.1;.  Therefore, it is suitable

	<filename><makevar>TMPPLIST</makevar></filename>.</para>

      <para>Another possibility to modify port's packing list is based
	on setting the variables <makevar>PLIST_FILES</makevar>,
	<makevar>PLIST_DIRS</makevar>, and
	<makevar>PLIST_DIRSTRY</makevar>.  The value of each variable is
	regarded as a list of pathnames to write to
	<filename><makevar>TMPPLIST</makevar></filename> along with
	<filename><makevar>PLIST</makevar></filename> contents.  Names
	listed in <makevar>PLIST_FILES</makevar>,
	<makevar>PLIST_DIRS</makevar>, and
	<makevar>PLIST_DIRSTRY</makevar> are subject to
	<literal>%%<replaceable>VAR</replaceable>%%</literal>
	substitution, as described above.  Except for that, names from
	<makevar>PLIST_FILES</makevar> will appear in the final
	packing list unchanged, while <literal>@dirrm</literal> and
	<literal>@dirrmtry</literal> will
	be prepended to names from <makevar>PLIST_DIRS</makevar>
	and <makevar>PLIST_DIRSTRY</makevar>, respectively.  To
	take effect, <makevar>PLIST_FILES</makevar>,
	<makevar>PLIST_DIRS</makevar>, and
	<makevar>PLIST_DIRSTRY</makevar> must be set before
	<filename><makevar>TMPPLIST</makevar></filename> is written,
	i.e., in <maketarget>pre-install</maketarget> or
	earlier.</para>

	<filename>pkg-plist</filename> file (with or without variable
	substitution), or embedded into the
	<filename>Makefile</filename> via
	<makevar>PLIST_FILES</makevar>,
	<makevar>PLIST_DIRS</makevar>, and
	<makevar>PLIST_DIRSTRY</makevar>.  Even if the contents are
	auto-generated by a tool or a target in the Makefile
	<emphasis>before</emphasis> the inclusion into the Ports
	Collection by a committer, this is still considered a static

Return to bug 181080

Lines 278-283 Link Here

(-)book.xml (-10 / +30 lines)
278	<para>Of course, <makevar>PLIST_DIRS</makevar> should be left	278	<para>Of course, <makevar>PLIST_DIRS</makevar> should be left
279	unset if a port installs no directories of its own.</para>	279	unset if a port installs no directories of its own.</para>
280		280
		281	<note>
		282	<para>It is possible that several ports share a common
		283	directory. In that case
		284	<makevar>PLIST_DIRS</makevar> should be replaced by
		285	<makevar>PLIST_DIRSTRY</makevar> so that the directory
		286	is removed only if empty, otherwise it is silently
		287	ignored. <makevar>PLIST_DIRS</makevar> and
		288	<makevar>PLIST_DIRSTRY</makevar> are equivalent to
		289	using <literal>@dirrm</literal> and
		290	<literal>@dirrmtry</literal> in
		291	<filename>pkg-plist</filename>, which are described in
		292	<xref linkend="plist-dir-cleaning"/>.</para>
		293	</note>
		294
281	<para>The price for this way of listing port's files and	295	<para>The price for this way of listing port's files and
282	directories is that you cannot use command sequences	296	directories is that you cannot use command sequences
283	described in &man.pkg.create.1;. Therefore, it is suitable	297	described in &man.pkg.create.1;. Therefore, it is suitable
Lines 9918-9937 Link Here
9918	<filename><makevar>TMPPLIST</makevar></filename>.</para>	9932	<filename><makevar>TMPPLIST</makevar></filename>.</para>
9919		9933
9920	<para>Another possibility to modify port's packing list is based	9934	<para>Another possibility to modify port's packing list is based
9921	on setting the variables <makevar>PLIST_FILES</makevar> and	9935	on setting the variables <makevar>PLIST_FILES</makevar>,
9922	<makevar>PLIST_DIRS</makevar>. The value of each variable is	9936	<makevar>PLIST_DIRS</makevar>, and
		9937	<makevar>PLIST_DIRSTRY</makevar>. The value of each variable is
9923	regarded as a list of pathnames to write to	9938	regarded as a list of pathnames to write to
9924	<filename><makevar>TMPPLIST</makevar></filename> along with	9939	<filename><makevar>TMPPLIST</makevar></filename> along with
9925	<filename><makevar>PLIST</makevar></filename> contents. Names	9940	<filename><makevar>PLIST</makevar></filename> contents. Names
9926	listed in <makevar>PLIST_FILES</makevar> and	9941	listed in <makevar>PLIST_FILES</makevar>,
9927	<makevar>PLIST_DIRS</makevar> are subject to	9942	<makevar>PLIST_DIRS</makevar>, and
		9943	<makevar>PLIST_DIRSTRY</makevar> are subject to
9928	<literal>%%<replaceable>VAR</replaceable>%%</literal>	9944	<literal>%%<replaceable>VAR</replaceable>%%</literal>
9929	substitution, as described above. Except for that, names from	9945	substitution, as described above. Except for that, names from
9930	<makevar>PLIST_FILES</makevar> will appear in the final	9946	<makevar>PLIST_FILES</makevar> will appear in the final
9931	packing list unchanged, while <literal>@dirrm</literal> will	9947	packing list unchanged, while <literal>@dirrm</literal> and
9932	be prepended to names from <makevar>PLIST_DIRS</makevar>. To	9948	<literal>@dirrmtry</literal> will
9933	take effect, <makevar>PLIST_FILES</makevar> and	9949	be prepended to names from <makevar>PLIST_DIRS</makevar>
9934	<makevar>PLIST_DIRS</makevar> must be set before	9950	and <makevar>PLIST_DIRSTRY</makevar>, respectively. To
		9951	take effect, <makevar>PLIST_FILES</makevar>,
		9952	<makevar>PLIST_DIRS</makevar>, and
		9953	<makevar>PLIST_DIRSTRY</makevar> must be set before
9935	<filename><makevar>TMPPLIST</makevar></filename> is written,	9954	<filename><makevar>TMPPLIST</makevar></filename> is written,
9936	i.e., in <maketarget>pre-install</maketarget> or	9955	i.e., in <maketarget>pre-install</maketarget> or
9937	earlier.</para>	9956	earlier.</para>
Lines 10059-10066 Link Here
10059	<filename>pkg-plist</filename> file (with or without variable	10078	<filename>pkg-plist</filename> file (with or without variable
10060	substitution), or embedded into the	10079	substitution), or embedded into the
10061	<filename>Makefile</filename> via	10080	<filename>Makefile</filename> via
10062	<makevar>PLIST_FILES</makevar> and	10081	<makevar>PLIST_FILES</makevar>,
10063	<makevar>PLIST_DIRS</makevar>. Even if the contents are	10082	<makevar>PLIST_DIRS</makevar>, and
		10083	<makevar>PLIST_DIRSTRY</makevar>. Even if the contents are
10064	auto-generated by a tool or a target in the Makefile	10084	auto-generated by a tool or a target in the Makefile
10065	<emphasis>before</emphasis> the inclusion into the Ports	10085	<emphasis>before</emphasis> the inclusion into the Ports
10066	Collection by a committer, this is still considered a static	10086	Collection by a committer, this is still considered a static