SYNOPSIS
build-twiki-kernel.pl [options] [-tempdir] [-outputdir] [-outfile]
[-agent]
Copyright 2004, 2005 Will Norris and Sven Dowideit. All Rights Reserved.
Options:
-tempdir [.] where all temporary files for this build are placed
-outfile final output filename (defaults to TWikiKernel-SVNBRANCH-SVNREV.tar.gz)
-outputdir [.] location of outfile
-changelog automatically generate CHANGELOG from SVN (requires xsltproc)
-tar generate .tar.gz output file (disable with -notar)
-zip generate .zip output file (disable with -nozip)
-agent [$Config->{agent}] LWP::UserAgent name (used for downloading some documentation from wiki pages on twiki.org)
-pdoc process source code using Pdoc to produce html in twiki/doc/ (autodetects if Pdoc installed)
-gendocs process source code using the equivalent of TWiki:Plugins.PerlPodPlugin
-verbose
-debug
-help this documentation
-man full docs
DESCRIPTION
build-twiki-kernel.pl will build a TWikiKernel release file base suit-
able for creating a TWikiRelease/TWikiDistribution
The TWikiKernel is comprised of several subsystems:
* CgiScripts - fulfils requests from the web. Primarily through the
ViewCgiScript
* AuthenticationSubSystem - authenticates users and bestows privi-
leges
* ParsePipeline - interprets what's typed in forms and topics and
converts into Topics, Forms, MetaData and Attachments
* StorageSubSystem - arranges for data to be stored, currently in
RcsFormat
* RenderingPipeline - displays WikiML Topics, Forms, MetaData and
Attachments as HTML
* SearchSubsystem - fulfils searches
Notably the TWikiKernel does not include any TWikiExtensions (e.g. Plu-
gins or Skins); they are bundled into a particular TWikiRelease (or
TWikiDistribution).
note that the existing terminology is used, and will need to be revisited when terminology is finalised.
--
WillNorris - 14 Apr 2005
sample build session:
su - twikibuilder
cd $TWIKIDEV/$BRANCH
svn update
cd $TWIKIDEV/$BRANCH/tools/distro
./build-twiki-kernel.pl --notar --outputdir=$TWIKIDEV/twikiplugins/lib/TWiki/Contrib/TWikiInstallerContrib/downloads/releases/
--
WillNorris - 23 Apr 2005