NAME
ProjectBuilder::CMS, part of the project-builder.org
DESCRIPTION
This modules provides configuration management system functions suitable
for pbinit calls.
USAGE
pb_cms_init
This function setup the environment for the CMS system related to the
URL given by the pburl configuration parameter. The potential
parameter indicates whether we should inititate the context or not. It
sets up environement variables (pbDIR, PBDIR, 1307ISION, PBCMSLOGFILE)
pb_cms_export
This function exports a CMS content to a directory. The first
parameter is the URL of the CMS content. The second parameter is the
directory in which it is locally exposed (result of a checkout). If
undef, then use the original CMS content. The third parameter is the
directory where we want to deliver it (result of export). It returns
the original tar file if we need to preserve it and undef if we use
the produced one.
pb_cms_get_uri
This function is only called with a real CMS system and gives the URL
stored in the checked out directory. The first parameter is the schema
of the CMS systems (svn, cvs, svn+ssh, ...) The second parameter is
the directory in which it is locally exposed (result of a checkout).
pb_cms_copy
This function copies a CMS content to another. The first parameter is
the schema of the CMS systems (svn, cvs, svn+ssh, ...) The second
parameter is the URL of the original CMS content. The third parameter
is the URL of the destination CMS content.
Only coded for SVN now as used for pbconf itself not the project
pb_cms_checkout
This function checks a CMS content out to a directory. The first
parameter is the schema of the CMS systems (svn, cvs, svn+ssh, ...)
The second parameter is the URL of the CMS content. The third
parameter is the directory where we want to deliver it (result of
export).
pb_cms_up
This function updates a local directory with the CMS content. The
first parameter is the schema of the CMS systems (svn, cvs, svn+ssh,
...) The second parameter is the directory to update.
pb_cms_checkin
This function updates a CMS content from a local directory. The first
parameter is the schema of the CMS systems (svn, cvs, svn+ssh, ...)
The second parameter is the directory to update from. The third
parameter indicates if we are in a new version creation (undef) or in
a new project creation (1)
pb_cms_add
This function adds to a CMS content from a local directory. The first
parameter is the schema of the CMS systems (svn, cvs, svn+ssh, ...)
The second parameter is the directory/file to add.
pb_cms_isdiff
This function returns a integer indicating the number f differences
between the CMS content and the local directory where it's checked
out. The first parameter is the schema of the CMS systems (svn, cvs,
svn+ssh, ...) The second parameter is the directory to consider.
pb_cms_get_pkg
This function returns the list of packages we are working on in a CMS
action. The first parameter is the default list of packages from the
configuration file. The second parameter is the optional list of
packages from the configuration file.
pb_cms_get_real_pkg
This function returns the real name of a virtual package we are
working on in a CMS action. It supports the following types: perl. The
first parameter is the virtual package name
pb_cms_compliant
This function checks the compliance of the project and the pbconf
directory. The first parameter is the key name of the value that needs
to be read in the configuration file. The second parameter is the
environment variable this key will populate. The third parameter is
the location of the pbconf dir. The fourth parameter is the URI of the
CMS content related to the pbconf dir. The fifth parameter indicates
whether we should inititate the context or not.
pb_cms_create_authors
This function creates a AUTHORS files for the project. It call it
AUTHORS.pb if an AUTHORS file already exists. The first parameter is
the source file for authors information. The second parameter is the
directory where to create the final AUTHORS file. The third parameter
is the schema of the CMS systems (svn, cvs, svn+ssh, ...)
pb_cms_log
This function creates a ChangeLog file for the project. The first
parameter is the schema of the CMS systems (svn, cvs, svn+ssh, ...)
The second parameter is the directory where the CMS content was
checked out. The third parameter is the directory where to create the
final ChangeLog file. The fourth parameter is unused. The fifth
parameter is the source file for authors information.
It may use a tool like svn2cl or cvs2cl to generate it if present, or
the log file from the CMS if not.
WEB SITES
The main Web site of the project is available at
. Bug reports should be filled using the
trac instance of the project at .
USER MAILING LIST
None exists for the moment.
AUTHORS
The Project-Builder.org team lead by
Bruno Cornec .
COPYRIGHT
Project-Builder.org is distributed under the GPL v2.0 license described in
the file "COPYING" included with the distribution.