Thu Jan 1 06:07:12 2015 UTC ()
Document BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM.


(dholland)
diff -r1.125 -r1.126 pkgsrc/doc/guide/files/fixes.xml

cvs diff -r1.125 -r1.126 pkgsrc/doc/guide/files/fixes.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/fixes.xml 2014/12/25 12:37:05 1.125
+++ pkgsrc/doc/guide/files/fixes.xml 2015/01/01 06:07:12 1.126
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: fixes.xml,v 1.125 2014/12/25 12:37:05 wiz Exp $ --> 1<!-- $NetBSD: fixes.xml,v 1.126 2015/01/01 06:07:12 dholland Exp $ -->
2 2
3<chapter id="fixes"> <?dbhtml filename="fixes.html"?> 3<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
4<title>Making your package work</title> 4<title>Making your package work</title>
5 5
6<sect1 id="general-operation"> 6<sect1 id="general-operation">
7 <title>General operation</title> 7 <title>General operation</title>
8 8
9 <sect2 id="portability-of-packages"> 9 <sect2 id="portability-of-packages">
10 <title>Portability of packages</title> 10 <title>Portability of packages</title>
11 11
12 <para>One appealing feature of pkgsrc is that it runs on many 12 <para>One appealing feature of pkgsrc is that it runs on many
13 different platforms. As a result, it is important to ensure, 13 different platforms. As a result, it is important to ensure,
14 where possible, that packages in pkgsrc are portable. This 14 where possible, that packages in pkgsrc are portable. This
@@ -502,29 +502,40 @@ CONFLICTS= baz-[0-9]* @@ -502,29 +502,40 @@ CONFLICTS= baz-[0-9]*
502 <programlisting> 502 <programlisting>
503CONFLICTS= bar-[0-9]* 503CONFLICTS= bar-[0-9]*
504 </programlisting> 504 </programlisting>
505 505
506 </sect2> 506 </sect2>
507 507
508 508
509 <sect2 id="not-building-packages"> 509 <sect2 id="not-building-packages">
510 <title>Packages that cannot or should not be built</title> 510 <title>Packages that cannot or should not be built</title>
511 511
512 <para>There are several reasons why a package might be 512 <para>There are several reasons why a package might be
513 instructed to not build under certain circumstances. If the 513 instructed to not build under certain circumstances. If the
514 package builds and runs on most platforms, the exceptions 514 package builds and runs on most platforms, the exceptions
515 should be noted with <varname>NOT_FOR_PLATFORM</varname>. If 515 should be noted with <varname>BROKEN_ON_PLATFORM</varname>. If
516 the package builds and runs on a small handful of platforms, 516 the package builds and runs on a small handful of platforms,
517 set <varname>ONLY_FOR_PLATFORM</varname> instead. 517 set <varname>BROKEN_EXCEPT_ON_PLATFORM</varname> instead.
 518 Both <varname>BROKEN_ON_PLATFORM</varname> and
 519 <varname>BROKEN_EXCEPT_ON_PLATFORM</varname> are OS triples
 520 (OS-version-platform) that can use glob-style
 521 wildcards.</para>
 522 <para>If a package is not appropriate for some platforms (as
 523 oopposed to merely broken), a different set of variables should be
 524 used as this affects failure reporting and statistics.
 525 If the package is appropriate for most platforms, the exceptions
 526 should be noted with <varname>NOT_FOR_PLATFORM</varname>. If
 527 the package is appropriate for only a small handful of platforms
 528 (often exactly one), set <varname>ONLY_FOR_PLATFORM</varname> instead.
518 Both <varname>ONLY_FOR_PLATFORM</varname> and 529 Both <varname>ONLY_FOR_PLATFORM</varname> and
519 <varname>NOT_FOR_PLATFORM</varname> are OS triples 530 <varname>NOT_FOR_PLATFORM</varname> are OS triples
520 (OS-version-platform) that can use glob-style 531 (OS-version-platform) that can use glob-style
521 wildcards.</para> 532 wildcards.</para>
522 <para>Some packages are tightly bound to a specific version of an 533 <para>Some packages are tightly bound to a specific version of an
523 operating system, e.g. LKMs or <filename 534 operating system, e.g. LKMs or <filename
524 role="pkg">sysutils/lsof</filename>. Such binary packages are not 535 role="pkg">sysutils/lsof</filename>. Such binary packages are not
525 backwards compatible with other versions of the OS, and should be 536 backwards compatible with other versions of the OS, and should be
526 uploaded to a version specific directory on the FTP server. Mark 537 uploaded to a version specific directory on the FTP server. Mark
527 these packages by setting <varname>OSVERSION_SPECIFIC</varname> to 538 these packages by setting <varname>OSVERSION_SPECIFIC</varname> to
528 <quote>yes</quote>. This variable is not currently used by any of 539 <quote>yes</quote>. This variable is not currently used by any of
529 the package system internals, but may be used in the 540 the package system internals, but may be used in the
530 future.</para> 541 future.</para>