Update the Build document

- Add build46
- Mention shorewall-pkg.config

Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2014-08-14 08:03:31 -07:00
parent aedd9b5a76
commit aa6bd2819c

View File

@ -164,7 +164,7 @@
<section> <section>
<title>build</title> <title>build</title>
<para>This is the script that builds Shorewall 4.4 packages from <para>This is the script that builds Shorewall 4.6 packages from
Git.</para> Git.</para>
<para>The script copies content from Git using the <command>git <para>The script copies content from Git using the <command>git
@ -220,7 +220,7 @@
<para>You should ensure that you have the latest scripts. The scripts <para>You should ensure that you have the latest scripts. The scripts
change periodically as we move through the release cycles.</para> change periodically as we move through the release cycles.</para>
<para>The build44 script may need to be modified to fit your particular <para>The build46 script may need to be modified to fit your particular
environment. There are a number of variables that are set near the top environment. There are a number of variables that are set near the top
of the file:</para> of the file:</para>
@ -270,10 +270,12 @@
</variablelist> </variablelist>
<para>The scripts assume that there will be a separate <firstterm>build <para>The scripts assume that there will be a separate <firstterm>build
directory</firstterm> per major release. To build a release, you cd to directory</firstterm> per major release.</para>
the appropriate directory and run the build script.</para>
<para>The general form of the build command is:</para> <para>To build a release, you cd to the appropriate directory and run
the build46 script.</para>
<para>The general form of the build46 command is:</para>
<blockquote> <blockquote>
<para><command>build</command> [ -<replaceable>options</replaceable> ] <para><command>build</command> [ -<replaceable>options</replaceable> ]
@ -401,13 +403,13 @@
</section> </section>
<section> <section>
<title>build45</title> <title>build45 and build46</title>
<para>This is the script that builds Shorewall 4.5 packages from <para>These are the scripts that respectively build Shorewall 4.5 and
Git.</para> Shorewall 4.6 packages from Git.</para>
<para>The script copies content from Git using the <command>git <para>The scripts copy content from Git using the <command>git
archive</command> command. It then uses that content to build the archive</command> command. They then use that content to build the
packages. In addition to the usual Gnu utilities, the following software packages. In addition to the usual Gnu utilities, the following software
is required:</para> is required:</para>
@ -451,7 +453,7 @@
<listitem> <listitem>
<para>Required to convert the XML manpages to manpages. Be sure <para>Required to convert the XML manpages to manpages. Be sure
that you have a recent version; I use 0.0.23.</para> that you have a recent version; I use 0.0.25.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -459,7 +461,7 @@
<para>You should ensure that you have the latest scripts. The scripts <para>You should ensure that you have the latest scripts. The scripts
change periodically as we move through the release cycles.</para> change periodically as we move through the release cycles.</para>
<para>The build44 script may need to be modified to fit your particular <para>The scripts may need to be modified to fit your particular
environment. There are a number of variables that are set near the top environment. There are a number of variables that are set near the top
of the file:</para> of the file:</para>
@ -509,14 +511,17 @@
</variablelist> </variablelist>
<para>The scripts assume that there will be a separate <firstterm>build <para>The scripts assume that there will be a separate <firstterm>build
directory</firstterm> per major release. To build a release, you cd to directory</firstterm> per major release. Each build directory should
the appropriate directory and run the build script.</para> contain the empty file <filename>shorewall-pkg.config</filename>; that
file is no longer used but has been retained just as a guard against
initiating a build in an unintended directory. To build a release, you
cd to the appropriate directory and run the build script.</para>
<para>The general form of the build command is:</para> <para>The general form of the build command is:</para>
<blockquote> <blockquote>
<para><command>build</command> [ -<replaceable>options</replaceable> ] <para><command>build</command>4x [ -<replaceable>options</replaceable>
<replaceable>release</replaceable> [ <replaceable>prior ] <replaceable>release</replaceable> [ <replaceable>prior
release</replaceable> ]</para> release</replaceable> ]</para>
</blockquote> </blockquote>
@ -632,8 +637,8 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>Example 1 - Build Shorewall 4.3.7 and generate patches against <para>Example 1 - Build Shorewall 4.5.7 and generate patches against
4.3.6:</para> 4.5.6:</para>
<blockquote> <blockquote>
<para><command>build45 4.5.7 4.5.6</command></para> <para><command>build45 4.5.7 4.5.6</command></para>