Building Shorewall from Git

Building Shorewall from Git Tom Eastep 2009 2010 2012 Thomas M. Eastep Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover, and with no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License. This information is provided primarily for Shorewall developers. Users are expected to install from pre-built tarballs or packages.

Git Taxonomy The Shorewall Git tree at Sourceforge serves as the master repository for Shorewall 4.4 and later versions. It is not possible to simply export a directory from Git and run the install.sh script in that directory. A build step is required to produce a directory that is suitable for the install.sh script to run in.

trunk The development branch of each product is kept here. Shorewall-core. Shorewall Shorewall6 Shorewall-lite Shorewall6-lite Shorewall-init There are also several other directories which are described in the following sub-sections.

trunk/docs The stable release XML documents. Depending on the point in the release cycle, these documents may also apply to the current development version.

tools This is where the release and build tools are kept. There are two subordinate directories: trunk/tools/build Tools for building and uploading new releases. trunk/tools/web Tools for publishing web content

web The files from the web site that are maintained in HTML format. are kept in this directory.

release Added in Shorewall 4.4.22, this directory contains the files that contain release-dependent information (change.txt, releasenotes.txt, .spec files, etc). This is actually a symbolic link to ../release which has its own Git repository.

Build Tools As described above, the build tools are kept in trunk/tools/build. They are described in the following sections.

setversion The setversion script updates the version number in a directory. The script is run with the current working directory being release.

setversion version

The version may either be a minor version or a patch version.

build This is the script that builds Shorewall 4.6 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 build46 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 build46 script. The general form of the build46 command is:

build [ -options ] release [ prior release ]

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 and build46 These are the scripts that respectively build Shorewall 4.5 and Shorewall 4.6 packages from Git. The scripts copy content from Git using the git archive command. They then use 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.25. You should ensure that you have the latest scripts. The scripts change periodically as we move through the release cycles. The scripts 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. Each build directory should contain the empty file shorewall-pkg.config; 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. The general form of the build command is:

build4x [ -options ] release [ prior release ]

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-core 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. s Build the shorewall 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.5.7 and generate patches against 4.5.6:

build45 4.5.7 4.5.6

Example 2 - Build Shorewall 4.5.7.1 Shorewall-core and generate patches against 4.5.7:

build45 -trc 4.5.7.1 4.5.7

upload This script is used to upload a release to www1.shorewall.net. The command is run in the build directory for the minor release of the product.

upload [ -products ] release

where products specifes the products to upload. If not given, all products are uploaded. This option is generally given only when uploading a patch release. c Upload the shorewall-core package. l Upload the shorewall-lite package. i Upload the shorewall-init package. s Upload the shorewall package. 6 Upload the shorewall6 package. L Upload the shorewall6-lite package. release The version number of the release to upload. Example 1 - Upload release 4.3.7:

upload 4.3.7

Example 2 - Upload shorewall-4.3.7.3:

upload -c 4.3.7.3

install.sh files Each product includes an install script (install.sh) that may be used to install the product on a machine or into a directory. By default, the scripts install the corresponding product into "/'; you can direct them to install into an empty existing directory by setting an environmental variable: DESTDIR (release 4.4.10 and later) PREFIX (all releases) There are a number of other environmental variables that you can set to cause the directory to be populated for a particular target environment: DEBIAN - Debian-based systems (Debian, Ubuntu, etc.) SUSE - SEL and OpenSuSE REDHAT - RHEL, CentOS, Foobar, etc. MAC - Apple MacIntosh (Shorewall and Shorewall6 packages only) CYGWIN - Cygwin under Windows (Shorewall and Shorewall6 packages only)