Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 7 Feb 2017 17:39:52 +0000 (UTC)
From:      Glen Barber <gjb@FreeBSD.org>
To:        doc-committers@freebsd.org, svn-doc-user@freebsd.org
Subject:   svn commit: r49945 - user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng
Message-ID:  <201702071739.v17HdqSQ084576@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: gjb
Date: Tue Feb  7 17:39:52 2017
New Revision: 49945
URL: https://svnweb.freebsd.org/changeset/doc/49945

Log:
  Minor updates while reworking the outline being used to
  update the RE processes:
  
  - Create a few convenience entities to save typing/typos.
  
  - Add a placeholder section (commented) to contain a list
    of files to edit when creating stable/X.
  
  Sponsored by:	The FreeBSD Foundation

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	Tue Feb  7 11:49:06 2017	(r49944)
+++ user/gjb/releng-rewrite/en_US.ISO8859-1/articles/freebsd-releng/article.xml	Tue Feb  7 17:39:52 2017	(r49945)
@@ -8,6 +8,11 @@
 <!ENTITY team.postmaster "&os; Postmaster Team">
 <!ENTITY team.re "&os; Release Engineering Team">
 <!ENTITY team.secteam "&os; Security Team">
+<!ENTITY branch.head "<literal xmlns='http://docbook.org/ns/docbook'>head/</literal>">;
+<!ENTITY branch.stable "<literal xmlns='http://docbook.org/ns/docbook'>stable/</literal>">;
+<!ENTITY branch.stablex "<literal xmlns='http://docbook.org/ns/docbook'>stable/<replaceable>11</replaceable>/</literal>">;
+<!ENTITY branch.releng "<literal xmlns='http://docbook.org/ns/docbook'>releng/</literal>">;
+<!ENTITY branch.relengx "<literal xmlns='http://docbook.org/ns/docbook'>releng/<replaceable>11.0</replaceable>/</literal>">;
 ]>
 <article xmlns="http://docbook.org/ns/docbook"
   xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
@@ -36,30 +41,30 @@
 
     <para>Development of &os; has a very specific workflow.  In
       general, all changes to the &os; base system are committed to
-      the <literal>head/</literal> branch, which reflects the top of
-      the source tree.</para>
+      the &branch.head; branch, which reflects the top of the source
+      tree.</para>
 
     <para>After a reasonable testing period, changes can then be
-      merged to the <literal>stable/</literal> branches.  The default
-      minimum timeframe before merging to <literal>stable/</literal>
-      branches is three (3) days.</para>
+      merged to the &branch.stable; branches.  The default minimum
+      timeframe before merging to &branch.stable; branches is three
+      (3) days.</para>
 
     <para>Although a general rule to wait a minimum of three days
-      before merging from <literal>head/</literal>, there are a few
-      special circumstances where an immediate merge may be necessary,
-      such as a critical security fix, or a bug fix that directly
-      inhibits the release build process.</para>
+      before merging from &branch.head;, there are a few special
+      circumstances where an immediate merge may be necessary, such as
+      a critical security fix, or a bug fix that directly inhibits the
+      release build process.</para>
 
     <para>After several months, and the number of changes in the
-      <literal>stable/</literal> branch have grown significantly, it
-      is time to release the next version of &os;.  These releases
-      have been historically referred to as <quote>point</quote>
+      &branch.stable; branch have grown significantly, it is time to
+      release the next version of &os;.  These releases have been
+      historically referred to as <quote>point</quote>
       releases.</para>
 
-    <para>In between releases from the <literal>stable/</literal>
-      branches, approximately every two (2) years, a release will be
-      cut directly from <literal>head/</literal>.  These releases
-      have been historically referred to as <quote>dot-zero</quote>
+    <para>In between releases from the &branch.stable; branches,
+      approximately every two (2) years, a release will be cut
+      directly from &branch.head;.  These releases have been
+      historically referred to as <quote>dot-zero</quote>
       releases.</para>
 
     <para>This article will highlight the workflow and
@@ -145,23 +150,22 @@
 
 	<tbody>
 	  <row>
-	    <entry><literal>head/</literal> slush:</entry>
+	    <entry>&branch.head; slush:</entry>
 	    <entry>August 24</entry>
 	  </row>
 
 	  <row>
-	    <entry><literal>head/</literal> freeze:</entry>
+	    <entry>&branch.head; freeze:</entry>
 	    <entry>September 7</entry>
 	  </row>
 
 	  <row>
-	    <entry><literal>head/</literal> KBI freeze:</entry>
+	    <entry>&branch.head; KBI freeze:</entry>
 	    <entry>September 21</entry>
 	  </row>
 
 	  <row>
-	    <entry><literal>stable/<replaceable>10</replaceable>/</literal>
-	      branch:</entry>
+	    <entry>&branch.stablex; branch:</entry>
 	    <entry>October 10</entry>
 	  </row>
 
@@ -176,8 +180,7 @@
 	  </row>
 
 	  <row>
-	    <entry><literal>releng/<replaceable>10.0</replaceable>/</literal>
-	      branch:</entry>
+	    <entry>&branch.relengx; branch:</entry>
 	    <entry>November 1</entry>
 	  </row>
 
@@ -201,10 +204,10 @@
 
     <note>
       <para>If the release is being created from an existing
-	<literal>stable/</literal> branch, the <acronym>KBI</acronym>
+	&branch.stable; branch, the <acronym>KBI</acronym>
 	freeze date can be excluded, since the <acronym>KBI</acronym>
 	is already considered frozen on established
-	<literal>stable/</literal> branches.</para>
+	&branch.stable; branches.</para>
     </note>
 
     <para>After general agreement on the schedule, the &team.re;
@@ -242,8 +245,8 @@
       to the <quote>code slush</quote> and <quote>code freeze</quote>
       during the &os; release cycle.</para>
 
-    <para>This applies to both <literal>head/</literal> and
-      <literal>stable/</literal> branches.</para>
+    <para>This applies to both &branch.head; and &branch.stable;
+      branches.</para>
 
     <sect2 xml:id="releng-code-slush">
       <title>The Code Slush</title>
@@ -292,11 +295,10 @@
   </sect1>
 
   <sect1 xml:id="releng-head">
-    <title>Release from <literal>head/</literal></title>
+    <title>Release from &branch.head;</title>
 
-    <para>This section describes the general procedures of the
-      &os; release cycle from the <literal>head/</literal>
-      branch.</para>
+    <para>This section describes the general procedures of the &os;
+      release cycle from the &branch.head; branch.</para>
 
     <sect2 xml:id="releng-head-builds-alpha">
       <title>&os; <quote><literal>ALPHA</literal></quote>
@@ -310,7 +312,7 @@
 
       <para>The idea behind <literal>-ALPHA</literal> builds is to
 	provide regular &os;-provided builds before the creation of
-	the <literal>stable/</literal> branch.</para>
+	the &branch.stable; branch.</para>
 
       <para>&os; <literal>-ALPHA</literal> snapshots should be built
 	approximately once a week.</para>
@@ -335,26 +337,45 @@
     </sect2>
 
     <sect2 xml:id="releng-head-branching">
-      <title>Creating the
-	<literal>stable/<replaceable>N</replaceable></literal>
-	Branch</title>
+      <title>Creating the &branch.stablex; Branch</title>
 
-      <para>&nbsp;</para>
+      <para>When creating the &branch.stable; branch, several changes
+	are required in both the new &branch.stable; branch and the
+	&branch.head; branch.</para>
+
+      <?ignore
+      <informaltable frame="none" pgwide="0">
+	<tgroup cols="2">
+	  <thead>
+	    <row>
+	      <entry>File to Edit</entry>
+	      <entry>What to Change</entry>
+	    </row>
+	  </thead>
+
+	  <tbody>
+	    <row>
+	      <entry>&nbsp;</entry>
+	      <entry>&nbsp;</entry>
+	    </row>
+	  </tbody>
+	</tgroup>
+      </informaltable>
+    ?>
     </sect2>
 
     <sect2 xml:id="releng-head-thaw">
-      <title>Code Thaw in <literal>head/</literal></title>
+      <title>Code Thaw in &branch.head;</title>
 
       <para>&nbsp;</para>
     </sect2>
   </sect1>
 
   <sect1 xml:id="releng-stable">
-    <title>Release from <literal>stable/</literal></title>
+    <title>Release from &branch.stable;</title>
 
-    <para>This section describes the general procedures of the
-      &os; release cycle from an extablished
-      <literal>stable/</literal> branch.</para>
+    <para>This section describes the general procedures of the &os;
+      release cycle from an extablished &branch.stable; branch.</para>
 
     <sect2 xml:id="releng-stable-builds-beta">
       <title>&os; <literal>-BETA</literal> Builds</title>
@@ -363,17 +384,13 @@
     </sect2>
 
     <sect2 xml:id="releng-stable-branching">
-      <title>Creating the
-	<literal>releng/<replaceable>N.M/</replaceable></literal>
-	Branch</title>
+      <title>Creating the &branch.relengx; Branch</title>
 
       <para>&nbsp;</para>
     </sect2>
 
     <sect2 xml:id="releng-stable-thaw">
-      <title>Code Thaw in the
-	<literal>stable/<replaceable>N/</replaceable></literal>
-	Branch</title>
+      <title>Code Thaw in the &branch.stablex; Branch</title>
 
       <para>&nbsp;</para>
     </sect2>



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