diff --git a/docs/Build.xml b/docs/Build.xml index 3531c75d4..39b909499 100644 --- a/docs/Build.xml +++ b/docs/Build.xml @@ -94,15 +94,6 @@ release cycle, these documents may also apply to the current development version. - -
- trunk/manpages, trunk/manpages6, trunk/manpages-lite and - trunk/manpages6-lite - - The stable release XML manpages. Depending on the point in the - release cycle, these documents may also apply to the current - development version. -
@@ -292,6 +283,245 @@ where + + + options + + + are one or more of the following. If no options are given + then all options are assumed + + + + t + + + build tar files + + + + + r + + + build RPMs + + + + + c + + + Build the shorewall package. + + + + + i + + + Build the shorewall-init package. + + + + + l + + + Build the shorewall-lite package. + + + + + 6 + + + Build the shorewall6 package. + + + + + L + + + Build the shorewall6-lite package. + + + + + h + + + Build the html document package. + + + + + x + + + Build the xml document package. + + + + + + + + release + + + The release version to build. Must match the version in the + associated Git path. + + + + + prior release + + + The release to be used to generate patch files. + + + + + Example 1 - Build Shorewall 4.4.7 and generate patches against + 4.4.6: + +
+ build 4.4.7 4.4.6 +
+ + Example 2 - Build Shorewall 4.2.7.1 Shorewall and generate patches + against 4.4.7: + +
+ build -trc 4.4.7.1 4.4.7 +
+
+ +
+ build45 + + This is the script that builds Shorewall 4.5 packages from + Git. + + The script copies content from Git using the git + archive command. It then uses that content to build the + packages. In addition to the usual Gnu utilities, the following software + is required: + + + + rpmbuild + + + Required to build the RPM packages. + + + + + xsltproc (libxslt) + + + Required to convert the XML documents to other + formats. + + + + + Docbook XSL Stylesheets + + + Required to convert the XML documents to other + formats. + + + + + Perl + + + Required to massage some of the config files. + + + + + xmlto + + + Required to convert the XML manpages to manpages. Be sure + that you have a recent version; I use 0.0.23. + + + + + You should ensure that you have the latest scripts. The scripts + change periodically as we move through the release cycles. + + The build44 script may need to be modified to fit your particular + environment. There are a number of variables that are set near the top + of the file: + + + + STYLESHEET + + + Must point to the XHTML docbook.xsl stylesheet from your + Docbook XSL Stylesheets installation. + + + + + LOGDIR + + + Directory where you want the build log placed. Defaults to + the current working directory. + + + + + RPMDIR + + + Points to your RPM directory . + + + + + DIR + + + Directory where you want the release to be built. Defaults + to the current working directory. + + + + + GIT + + + Shorewall GIT repository. + + + + + The scripts assume that there will be a separate build + directory per major release. To build a release, you cd to + the appropriate directory and run the build script. + + The general form of the build command is: + +
+ build [ -options ] + release [ prior + release ] +
+ + where + options @@ -406,14 +636,14 @@ 4.3.6:
- build 4.3.7 4.3.6 + build45 4.5.7 4.5.6
- Example 2 - Build Shorewall 4.2.7.1 Shorewall and generate patches - against 4.2.7: + Example 2 - Build Shorewall 4.5.7.1 Shorewall-core and generate + patches against 4.5.7:
- build -trc 4.3.7.1 4.3.7 + build45 -trc 4.5.7.1 4.5.7