Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 23 Mar 2017 20:32:21 +0000 (UTC)
From:      Glen Barber <gjb@FreeBSD.org>
To:        doc-committers@freebsd.org, svn-doc-user@freebsd.org
Subject:   svn commit: r50079 - user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng
Message-ID:  <201703232032.v2NKWLtM097158@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: gjb
Date: Thu Mar 23 20:32:21 2017
New Revision: 50079
URL: https://svnweb.freebsd.org/changeset/doc/50079

Log:
  Move the 'releng-building' section to its own file.
  Document the relationship between release.sh and thermite.sh,
  and the purpose each serves.
  
  Sponsored by:	The FreeBSD Foundation

Added:
  user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/releng-building.xml   (contents, props changed)
Modified:
  user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/article.xml

Modified: user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/article.xml
==============================================================================
--- user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/article.xml	Thu Mar 23 17:35:03 2017	(r50078)
+++ user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/article.xml	Thu Mar 23 20:32:21 2017	(r50079)
@@ -15,6 +15,7 @@
 <!ENTITY branch.relengx "<literal xmlns='http://docbook.org/ns/docbook'>releng/<replaceable>11.0</replaceable>/</literal>">;
 
 <!-- Externally included files -->
+<!ENTITY release.building SYSTEM "./releng-building.xml">
 <!ENTITY release.major.version SYSTEM "./releng-major-version.xml">
 <!ENTITY release.minor.version SYSTEM "./releng-minor-version.xml">
 <!ENTITY release.terminology SYSTEM "./releng-terminology.xml">
@@ -329,6 +330,7 @@
   &release.terminology;
   &release.major.version;
   &release.minor.version;
+  &release.building;
 
   <sect1 xml:id="releng-wrapup">
     <title>Wrapping up the Release Cycle</title>
@@ -336,31 +338,4 @@
     <para>This section describes general post-release tasks.</para>
   </sect1>
 
-  <sect1 xml:id="releng-building">
-    <title>Building the Installer Images</title>
-
-    <para>This section describes how to build the installation images
-      as part of the &os; release cycle.</para>
-
-    <sect2 xml:id="releng-release-releasesh">
-      <title>The <filename>release.sh</filename> Script</title>
-
-      <para>&nbsp;</para>
-    </sect2>
-
-    <sect2 xml:id="releng-release-releaseconf">
-      <title>The <filename>release.conf</filename>
-	Configuration</title>
-
-      <para>&nbsp;</para>
-    </sect2>
-
-    <sect2 xml:id="releng-release-archnotes">
-      <title>Information About <filename>release.sh</filename> and
-	<filename>release.conf</filename> for Specific
-	Architectures</title>
-
-      <para>&nbsp;</para>
-    </sect2>
-  </sect1>
 </article>

Added: user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/releng-building.xml
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/releng-building.xml	Thu Mar 23 20:32:21 2017	(r50079)
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+     The FreeBSD Documentation Project
+
+     $FreeBSD$
+-->
+<sect1 xml:id="releng-building">
+  <title>Building &os; Installation Media</title>
+
+  <para>This section describes the general procedures producing &os;
+    development snapshots and releases.</para>
+
+  <sect2 xml:id="releng-build-scripts">
+    <title>Release Build Scripts</title>
+
+    <para>This section describes the build scripts used by &team.re;
+      to produce development snapshots and releases.</para>
+
+    <sect3 xml:id="releng-build-scripts-single">
+      <title>The <filename>release.sh</filename> Script</title>
+
+      <para>Prior to &os;&nbsp;9.0-RELEASE,
+	<filename>src/release/Makefile</filename> was updated to
+	support &man.bsdinstall.8;, and the
+	<filename>src/release/generate-release.sh</filename> script
+	was introduced as a wrapper to automate invoking the
+	&man.release.7; targets.</para>
+
+      <para>Prior to &os;&nbsp;9.2-RELEASE,
+	<filename>src/release/release.sh</filename> was introduced,
+	which heavily based on
+	<filename>src/release/generate-release.sh</filename> included
+	support to specify configuration files to override various
+	options and environment variables.  Support for configuration
+	files provided support for cross building each architecture
+	for a release by specifying a separate configuration file for
+	each invocation.  See &man.release.7; and
+	<filename>src/release/release.conf.sample</filename> for more
+	details.</para>
+    </sect3>
+
+    <sect3 xml:id="releng-build-scripts-multiple">
+      <title>The <filename>thermite.sh</filename> Wrapper
+	Script</title>
+
+      <para>In order to make cross building the full set of
+	architectures supported on a given branch faster, easier, and
+	reduce human error factors, a wrapper script around
+	<filename>src/release/release.sh</filename> was written to
+	iterate through the various combinations of architectures and
+	invoke <filename>src/release/release.sh</filename> using
+	a configuration file specific to that architecture.</para>
+
+      <para>The wrapper script is called
+	<filename>thermite.sh</filename>, which is available in the
+	&os; Subversion repository at
+	<literal>svn://svn.freebsd.org/user/gjb/thermite/</literal>,
+	in addition to configuration files used to build
+	&branch.head; and &branch.stablex; development
+	snapshots.</para>
+    </sect3>
+  </sect2>
+
+  <sect2 xml:id="releng-build-snapshot">
+    <title>Building &os; Development Snapshots</title>
+
+    <para>&nbsp;</para>
+  </sect2>
+
+  <sect2 xml:id="releng-build-release">
+    <title>Building &os; Releases</title>
+
+    <para>&nbsp;</para>
+  </sect2>
+</sect1>



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201703232032.v2NKWLtM097158>