diff --git a/docs/Build.xml b/docs/Build.xml index 2932cfcf7..2da80e5c2 100644 --- a/docs/Build.xml +++ b/docs/Build.xml @@ -5,7 +5,7 @@ - Building Shorewall from SVN + Building Shorewall from Git @@ -37,37 +37,17 @@ This information is provided primarily for Shorewall developers. Users are expected to install from pre-built tarballs or packages. - - Beginning with Shorewall 4.4, the Shorewall project will use Git as - it's SCM system rather than SVN. This document will be updated prior to - the release of 4.4 to refect the move to Git.
- SVN Taxonomy + Git Taxonomy - The Shorewall SVN tree at Sourceforge has a number of branches which - are described in the following sections. It is not possible to simply - export a directory from SVN 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. - -
- tags - - As new stable releases are made, they are copied into this branch. - Each release has it's own directory which is named with the minor - release number (e.g., 4.2.6). -
- -
- branches - - The latest copy of each stable major release is kept in this - branch. Each major release has its own directory which is named with the - major release number (e.g., 4.2). -
+ 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 SVN 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 @@ -169,48 +149,17 @@ The version may either be a minor - version or a patch version. The sub-directores that are updates are - those which match the specified version: - - - - Minor Version (e.g., 4.2.7) - - - Updates Shorewall, Shorewall-common, Shorewall-perl, - Shorewall-shell, Shorewall-lite, Shorewall6 and Shorewall6-lite. - Only those directories that are present are updated. - - - - - Patch Version (e.g., 4.2.7.1) - - - Update those directories matching the patch version - n (last digit): - Shorewall-n - ,Shorewall-common-n, - Shorewall-shell-n, - Shorewall-lite-n, - Shorewall6-n, and - Shorewall6-lite-n. - - - + version or a patch version.
- buildshorewall and build44 + build44 - These are the scripts that build Shorewall packages from SVN. The - buildshorewall script builds Shorewall 4.0 and - Shorewall 4.2 packages; the build44 script builds - Shorewall 4.3 and 4.4 packages. Because the scripts work similarly, they - will be described together. + This is the script that builds Shorewall packages from Git. + - The build scripts copy content from SVN using the svn - export command. They then use that content to build the + The script copies content from Git using the svn + archive command. It then uses that content to build the packages. In addition to the usual Gnu utilities, the following software is required: @@ -311,10 +260,10 @@ - SVN + GIT - Shorewall SVN repository + Shorewall GIT repository @@ -326,24 +275,14 @@ The general form of the build command is:
- buildscript [ - -options ] - release [ prior + build44 [ -options + ] release [ prior release ]
where - - buildscript - - - is either buildshorewall or - build44 - - - options @@ -380,9 +319,7 @@ c - Build the common package - (shorewall-common on versions 4.0 and 4.2 and shorewall on - 4.3 and later) + Build the shorewall package. @@ -436,7 +373,7 @@ The release version to build. Must match the version in the - associated SVN path. + associated Git path. @@ -565,61 +502,4 @@
- -
- Patch Releases - - Patch releases are created when a defect is found in the current - stable release of one of the products and the nature of the problem - warrents releasing a fix before the next minor release. The basic steps in - creating a patch release n are as - follows: - - - - Create - tags/minor-version/Shorewall-common-n - or Shorewall-n depending on which release. - If that product is being changed, the svn cp - command can be used. Otherwise, use svn mkdir and - then svn cp the changelog.txt - and releasenotes.txt files from the last release - (either the minor release itself or the preceding patch - release. - - - - For each of the other products, create a - product-n directory (e.g., - Shorewall-perl-n) using svn - cp. Again the last released version of the minor version of - the product should be the source. - - - - Apply the changes necessary to fix the bug, including updating - the change log and release notes. - - - - Run setversion to set the version of the - updated product(s). - - - - Create - tags/minor-version/known_problems.txt - if it doesn already exist and add a description of the defect and - indicate the patch release in which it was corrected. - - - - Commit the fix to SVN. - - - - Build the product(s). - - -