From 979ebfea0a311626353d7e1b0f390b024190ae8b Mon Sep 17 00:00:00 2001
From: rillig <rillig@pkgsrc.org>
Date: Fri, 30 Jun 2006 08:58:16 +0000
Subject: Added a chapter "The implementation of the bulk builds" that
 describes how the bulk builds should look like in the future. It is a design
 document and subject to discussion.

---
 doc/guide/files/Makefile      |  3 ++-
 doc/guide/files/chapters.ent  |  3 ++-
 doc/guide/files/infr.bulk.xml | 51 +++++++++++++++++++++++++++++++++++++++++++
 doc/guide/files/pkgsrc.xml    |  5 +++--
 4 files changed, 58 insertions(+), 4 deletions(-)
 create mode 100644 doc/guide/files/infr.bulk.xml

(limited to 'doc/guide')

diff --git a/doc/guide/files/Makefile b/doc/guide/files/Makefile
index fdf034afe51..c881f0059b8 100644
--- a/doc/guide/files/Makefile
+++ b/doc/guide/files/Makefile
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.9 2006/06/01 08:39:03 rillig Exp $
+# $NetBSD: Makefile,v 1.10 2006/06/30 08:58:16 rillig Exp $
 
 WEB_PREFIX?=	${.CURDIR}/../htdocs
 
@@ -19,6 +19,7 @@ SRCS+=	faq.xml
 SRCS+=	fixes.xml
 SRCS+=	ftp-layout.xml
 SRCS+=	getting.xml
+SRCS+=	infr.bulk.xml
 SRCS+=	infr.design.xml
 SRCS+=	introduction.xml
 SRCS+=	logs.xml
diff --git a/doc/guide/files/chapters.ent b/doc/guide/files/chapters.ent
index b3dcfd499cb..66bc4119ca4 100644
--- a/doc/guide/files/chapters.ent
+++ b/doc/guide/files/chapters.ent
@@ -1,7 +1,7 @@
 <!--
 	Creates entities for each chapter in the pkgsrc book.
 
-	$NetBSD: chapters.ent,v 1.12 2006/06/01 08:39:03 rillig Exp $
+	$NetBSD: chapters.ent,v 1.13 2006/06/30 08:58:16 rillig Exp $
 -->
 
 <!ENTITY chap.intro			SYSTEM "introduction.xml">
@@ -32,6 +32,7 @@
 <!-- The pkgsrc infrastructure -->
 <!ENTITY chap.infr.design		SYSTEM "infr.design.xml">
 <!ENTITY chap.regression		SYSTEM "regression.xml">
+<!ENTITY chap.infr.bulk			SYSTEM "infr.bulk.xml">
 <!ENTITY chap.porting			SYSTEM "porting.xml">
 
 <!-- appendix -->
diff --git a/doc/guide/files/infr.bulk.xml b/doc/guide/files/infr.bulk.xml
new file mode 100644
index 00000000000..e1bbb7d2830
--- /dev/null
+++ b/doc/guide/files/infr.bulk.xml
@@ -0,0 +1,51 @@
+<!-- $NetBSD: infr.bulk.xml,v 1.1 2006/06/30 08:58:16 rillig Exp $ -->
+
+<chapter id="infr.bulk">
+<title>The implementation of the pkgsrc bulk builds</title>
+
+<sect1 id="infr.bulk.what">
+<title>Deciding which packages to build</title>
+
+<note><para>This is not yet implemented.</para></note>
+
+	<para>Some of the pkgsrc packages are not usable in a certain
+	build configuration, either because of platform limitations
+	(processor, operating system) or because the build is done by an
+	unprivileged user. This section lists all the conditions that
+	influence whether a package is excluded from a bulk
+	build.</para>
+
+	<itemizedlist>
+
+	<listitem><para><varname>ONLY_FOR_PLATFORM</varname> or
+	<varname>NOT_FOR_PLATFORM</varname> may be defined in the
+	package <filename>Makefile</filename>.</para></listitem>
+
+	<listitem><para><varname>ONLY_FOR_COMPILER</varname> or
+	<varname>NOT_FOR_COMPILER</varname> may be defined in the
+	package <filename>Makefile</filename>.</para></listitem>
+
+	<listitem><para><varname>NOT_FOR_UNPRIVILEGED</varname> (does
+	not exist yet) may be defined in the package
+	<filename>Makefile</filename> (only affects bulk builds in
+	unprivileged mode).</para></listitem>
+
+	<listitem><para><varname>LICENSE</varname> may be defined in the
+	package <filename>Makefile</filename>. This may be overridden by
+	defining <varname>ACCEPTABLE_LICENSES</varname> in
+	<filename>mk.conf</filename>.</para></listitem>
+
+	<listitem><para>The package vulnerability database may list the
+	package as vulnerable. This may be overridden by defining 
+	<varname>ALLOW_VULNERABLE_PACKAGES</varname> in
+	<filename>mk.conf</filename>.</para></listitem>
+
+	<listitem><para>Packages that define
+	<varname>INTERACTIVE_STAGE</varname> cannot be built by the bulk
+	builds, which are by definition
+	non-interactive.</para></listitem>
+
+	</itemizedlist>
+
+</sect1>
+</chapter>
diff --git a/doc/guide/files/pkgsrc.xml b/doc/guide/files/pkgsrc.xml
index 34dbe928cbe..fb3c38ab705 100644
--- a/doc/guide/files/pkgsrc.xml
+++ b/doc/guide/files/pkgsrc.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: pkgsrc.xml,v 1.19 2006/06/01 08:39:03 rillig Exp $ -->
+<!-- $NetBSD: pkgsrc.xml,v 1.20 2006/06/30 08:58:16 rillig Exp $ -->
 
 
 <?xml version="1.0"?>
@@ -45,7 +45,7 @@
       <holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder>
     </copyright>
 
-    <pubdate>$NetBSD: pkgsrc.xml,v 1.19 2006/06/01 08:39:03 rillig Exp $</pubdate>
+    <pubdate>$NetBSD: pkgsrc.xml,v 1.20 2006/06/30 08:58:16 rillig Exp $</pubdate>
 
     <abstract>
 
@@ -106,6 +106,7 @@
 
     &chap.infr.design;
     &chap.regression;
+    &chap.infr.bulk;
     &chap.porting;
   </part>
 
-- 
cgit v1.2.3