Changeset 1762

Timestamp:

05/30/05 01:23:36 (4 years ago)

Author:

whmoseley

Message:

Update the README.cvs. Remind me to update it again when we actaully make a
release -- in case things don't go as I think they will...

Files:

• trunk/swish-e/README.cvs (modified) (8 diffs)
• trunk/swish-e/swish-daily.pl (modified) (14 diffs)

trunk/swish-e/README.cvs

@@ -1 +1 @@
-Using CVS
-
+
-
-Swish-e is available via cvs from SourceForge.  See http://swish-e.org for
@@ -14 +14 @@
-  make check
-  make install
-
+
-Only 'make install' might require root priviledges, depending on the permissions
-of /path/to/install.
@@ -24 +24 @@
-
-Building with HTML docs
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-you can then proceed to building Swish-e with:
-
-
+/
-  make
-  make check
-  make install
-
+
+
+
+
+
+
-See the swish_website/README for more about the HTML documentation.
-
-
-Daily Builds
-
+
-
-The swish-daily.pl script can be used to build swish-e from cvs (or
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
@@ -57 +79 @@
-
-Release and Tag
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-2) Edit the pod/CHANGES.pod file to update the date of the release
@@ -68 +104 @@
-4) run ./bootstrap to create new Makefile.in with new version string
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-   then test on a few platforms
-
@@ -84 +124 @@
-9) Tag the release.  For example:
-
-
+ 
-
-10) Upload to swish-e site -- see "Update Site" below for details before doing this.
@@ -90 +130 @@
-Now move on to development.  Change version in configure.in (2.5.0 for example),
-run ./bootstrap and check in.
+
+
+Update Site
+-----------
+
+Updating the site for a new release means updating the web site, such as the
+main page to announce the new release, and to build the web site using the new
+release so the on-line documentation is up to date.
+
+This is always a bit more hands-on due to changes in the build system between
+releases.
+
+See swish_website/README for more details on building the web site, but
+basically the swish_website script (bin/build) needs to know where to find the
+source for both the release and the current development builds.  This is currently done by
+two symlinks "swishsrc" and "develsrc".  develsrc points to the daily build directory:
+
+
+For example:
+
+    develsrc -> /home/bmoseley/swish/swish_daily_build/latest_swish_build/source
+
+The daily builds are created with the swish-daily.pl script.  swish-daily.pl fetches the
+source via cvs (with daily builds) or via a URL (for releases), unpacks into the "source"
+directory and builds swish-e.  If all goes well a symlink is created to the
+"latest_swish_build".
+
+This same process can be used to build a release.  But, instead of fetching from cvs[1]
+you fetch a tarball built above and placed in some location to fetch by URL.
+
+The swish_website/Build_Release.sh script does this by running:
+
+    #!/bin/sh
+
+    DIR="${BASE_DIR:=$HOME/swish}"
+
+    if test ! -n "$1"; then
+        echo "Must specify URL to fetch"
+        exit 1
+    fi
+
+    TAR_URL="$1"
+
+    swish-daily.pl \
+        --fetchtarurl="$TAR_URL" \
+        --topdir=$DIR/swish_release_build \
+        --noremove \
+        --notimestamp \
+        --verbose \
+        --tardir=$DIR/swish-releases || exit 1;
+
+So, run that script and pass a URL, swish-daily.pl will fetch the script, attempt to
+build and install swish-e, and then build a tarball and place it in the swish-releases
+directory and upate the latest.tar.gz link.  That basically makes the tarball available in
+the download directory, but it cannot be seen yet until the website is updated.
+
+For that you can run the swish_website/build.sh script, passing -a to tell it to build the
+entire site.
+
+
-
-
@@ -183 +283 @@
-
-
-************ Bill TODO ***********
-Update Site
------------
-
-These are notes from the README on the swish-e.org site (in the builds directory).
-Some of these notes duplicate comments from above.
-
-
-To make a release:
-
-This uses the swish-daily.pl script.  It still needs updating to
-work better with a "release" (namely the script used here has been modified
-to not remove old tarballs and to not copy the build logs to the Download directory.
-
-Need to find time to update the swish-daily script to read params from a soruce file.
-
-To create a release:
-
-1) update configure.in's version number and run a make distcheck.
-     Then cvs ci to update the version in cvs
-     And tag the files:  cvs tar rel-2-4-0
-
-2) I scp the tarball to swish-e.org's top directory (just a place with web access)
-3) run the build scrip:
-
-   ./swish-daily.pl -notimestamp -fetchtarurl=http://swish-e.org/swish-e-2.4.0.tar.gz
-
-(Be careful about permissions here as it does try and move links around)
-
-That will fetch the tarball, unpack into a build directory, and make install into
-an install directory (all this happens in the /data/_a/webdata/SWISH-E/builds directory.
-
-The HTML docs are indexed and the symlink at /data/_a/webdata/SWISH-E/current/docs is
-updated to point to this install directory.
-
-Then make dist is run and the resulting tarball is copied to
-/data/_a/webdata/SWISH-E/Download
-
-The --notimestamp option disables the timestamp option used by configure to add a date to
-the version number.
-
-Note that a "lastinstall" file is used to track the last installation directory.  So next
-time a build is created the old installation directory is removed.
-
-4) Edit Download/HEADER, index.html, swish-daily/HEADER to reflect the right version
-
-5) Announce on list.
-
-6) back at cvs, change to a new dev version by editing configure.in, ./bootstrap and
-checkin.
-
-

trunk/swish-e/swish-daily.pl

@@ -10 +10 @@
-
-# Script to build swish-e from cvs (or LWP request tarball)
- and the development docs
+
-
-# Default checkout location
@@ -29 +29 @@
-        logs            => 1,   # write log files
-        symlink         => 1,   # create symlink
-        htmldocs        => 'build_swish_docs',  # tool to build the swish docs
-);
-
@@ -51 +50 @@
-       help man options
-       config_options=s
-       htmldocs=s
-    /
-) or pod2usage(
@@ -70 +68 @@
-    [ \&cvs_checkout, 'Check out from CVS' ],  # can be replaced by a LWP fetch with --fetchtarurl=<url>
-    [ \&configure,    'Run configure' ],
-    [ \&builddocs,    'Build HTML docs' ],
-    [ \&make_install, 'Run make install' ],
-    # (old docs)[ \&make_docs,    "Run make docs" ],
-    [ \&make_dist,    "Run make dist and move tarball to $config{tardir}"  ],
-    [ \&set_symlink,  "Make symlink $config{symlink} point to $config{day_dir}" ],
@@ -172 +168 @@
-}
-
-#======================================================================
-# This creates the HTML docs in the build directory
-
-sub builddocs {
-    my $c = shift;
-
-    my $html_dir = "$c->{builddir}/html";
-
-    log_message( "Build HTML docs in directory $html_dir" );
-
-    run_command( "$c->{htmldocs} -swishsrc=$c->{srcdir} -poddest=$html_dir" );
-}
-
-
@@ -290 +274 @@
-
-
-#=================================================================================
-# Create HTML docs and index them
-
-
-sub make_docs {
-    my $c = shift;
-    my $options = $c->{configure_options} || '';
-
-    chdir "$c->{builddir}/html" || die "Failed to chdir $c->{builddir}/html: $!";
-    log_message( "Changed to html build directory: $c->{builddir}/html" );
-
-    run_command( "make searchdoc" ) || return;
-
-    return 1;
-}
-
-#===================================================================================
@@ -389 +358 @@
-    $config->{topdir} ||= getcwd;
-    $config->{topdir} = Cwd::abs_path( $config->{topdir} );
-
+ - perhaps invalid directory
-
-
@@ -505 +474 @@
-    -dump                   dump configuration and exit.  Good for seeing defaults
-    -ask                    ask what tasks to run
-    -htmldocs=<program>     the location of the build script for the HTML docs
-    -tardir=<path>          where to place tarball when finished
-    -tar_keep_days=<int>    number of days to keep old tarballs (default 15 days)
@@ -521 +489 @@
-    swish-daily.pl \
-        -cvsco='cvs -z3 -d:ext:moseley@cvs.sourceforge.net:/cvsroot/swishe' \
-        -htmldocs=$HOME/swish_website/bin/build \
-        -tardir=tardir
-
@@ -527 +494 @@
-=head1 DESCRIPTION
-
-
+
+
+
-
-A build directory is created (using the date and a sequence number).  This directory is
@@ -541 +510 @@
-tar files will be purged (based on tar_keep_days option).
-
-The html docs are indexed using the newly built swish making them searchable.
-
-If all goes well a symlink is created in the topdir pointing to the latest build directory.
-This symlink can be used to link to the latest version of the HTML docs and to the error
@@ -549 +516 @@
-Finally, old build directories are removed (based on build_keep_days option).
-
+=head2 Building HTML documentation
+
+The swish-e configure script
+
+=head2 Examples
+
+A daily script might use:
+
+    swish-daily.pl \
+        --topdir=$HOME/swish_daily_build \\
+        --tardir=$HOME/swish-daily
+
+Which creates a directory structure like:
+
+    $ ls -l swish_daily_build/
+    latest_swish_build -> swish-e-2005-05-29
+    swish-e-2005-05-26
+    swish-e-2005-05-27
+    swish-e-2005-05-28
+    swish-e-2005-05-29
+
+
+When building a release:
+
+    swish-daily.pl \
+        --fetchtarurl=<some url>
+        --topdir=$HOME/swish_release_build \
+        --tardir=$HOME/swish-releases \
+        --noremove \
+        --notimestamp \
+
+Use --noremove to avoid purging old builds, and --notimestamp to prevent adding a time
+stamp to the version (which is done when creating the daily builds).
+
-
-=head1 OPTIONS
@@ -572 +573 @@
-Specifies a URL where to fetch the tarball.  This will replace the use of cvs for fetching the source.
-
-=item B<-htmldocs>
-
-Lists the "bin/build" program from the "swish_website" cvs module -- used for building the
-html documentation.  This is needed because the html docs are not in cvs.
-
-The default is "build_swish_doc", which could be a shell script to bin/build.
-
-You could set this to "echo" to disable building docs.  You would also need to set
-config_options to include --disable-docs to say it's ok to build without docs.  But then
-you would end up with a broken distribution file.
-
-=item B<-[no]timestamp>
@@ -618 +609 @@
-  55 1 * * * . $HOME/.bashrc && $HOME/swish-daily.pl --tardir=$HOME/swish-daily --topdir=$HOME/swish_daily_build || echo "Check Swish Daily Build"
-
-
-=head1 COPYRIGHT
-