Elizabeth Grace Frank-Backman > SVN-Friendly > SVN::Friendly

Download:
SVN-Friendly-0.999_002.tar.gz

Annotate this POD

Source  

NAME ^

SVN::Friendly - user friendly front end to Subversion bindings

DESCRIPTION ^

Svn::Friendly presents the SWIG bindings for the Subversion API in a Perl friendly format.

It was developed because the raw SWIG bindings (available on CPAN via Alien::SVN) requires a deep reading of the SVN C API documentation and a lot of research, trial and error to figure out how the various C API constructs and data types show up in the Perl interface. This essentially meant that the Subversion Perl API was largely usable only to Perl programmers who also had a reading knowledge of C, familiarity with SWIG, and the time to spend doing the necessary research and testing.

For an in depth discussion of how SVN::Friendly makes the Perl bindings to subversion more user friendly ,see SVN::Friendly::Client.

COMPONENTS ^

Main modules corresponding to major subsystems in the subversion API:

Utility files that may be of interest

For planned future developments, see "ROADMAP".

DEPENDENCIES ^

This distribution requires only two additional non-core packages.

VERSION COMPATIBILITY ^

SVN::Friendly is composed so as to be backwards compatbile with subversion 1.1 and will continue to be so. All methods without a major_minor suffix use API method calls that are compatible with subversion 1.1 binaries.

To date, it is written to be forwards compatible up to subversion 1.7 and the intent is continue to add new releases as subversion does.

However, ...

You should not assume that downloading and installing SVN::Friendly will automatically make a computer with subversion 1.1 installed start acting like subversion 1.7, or vice versa.

The actual behavior of this distribution depends on three factors:

* the version of Alien::SVN you have installed

* the subversion release running on your computer

* the version of your working copy and repository

On a particular computer accessing a particular repository, the features available to you will be the least of the four releases listed above (Alien::SVN, system subversion, working copy version, and repository version).

SVN::Friendly depends on the SWIG-Perl bindings developed by the Subversion team. The Perl binding prepare Perl programs for linking to the subversion binaries at runtime. They also define the symbols available for use in a Perl program. Your program can only recognize functions and constants from the API against which Alien::SVN is compiled. If you try to use constants and methods from newer versions of Perl, strict and warnings will complain.

At runtime, your Perl/Subversion application will link to the system subversion (the one you use on the command line) and use that to make function calls. This is true even with Alien::SVN which downloads the 1.6.12 bindings for the purpose of compiling the Perl bindings. If your runtime system is older than 1.6, you will only be able to use the portion of the SWIG bindings that are appropriate for your runtime version. Attempts to call functions belonging to later APIs will fail.

The version of the working copy and the repository can also interfere with a Perl program. If you check out files using subversion 1.4, you can't necessarily check them back in with subversion 1.3. This is because the working copy format changes from time to time. An earlier version of subversion can't be used to manipulate a working copy created with a later version.

As for repositories, subversion is fairly good about making sure that an old version of subversion can read a repository created by a newer version and vice-versa. However, some features of the newer repository will be invisible to older clients. For example, Checking data out of a 1.7 repository won't magically give subversion 1.3 access to changelists, patches, and other post 1.3 features.

CAVEATS ^

The following caveats affect only methods ending in a major_minor version prefix. For details, see the individual modules.

Additionally, this module was tested against Subversion bindings compiled for subversion 1.4. It may be that later releases of the SWIG bindings will have introduced bugs into the 1.4 API. There is however an ample test suite to check for that. If this module installs for you via CPAN, you shuld be fairly safe even if you are using SWIG bindings compiled against a later API.

Finally, in general, one should mention that no test suite is ever complete. There is always the possibility that an untried combination of parameters will trigger a fault.

If you detect any bugs, the maintainer would be grateful if you would report them via CPAN. Many thanks in advance.

KNOWN BUGS ^

See individual modules.

ROADMAP ^

VOLUNTEERS ^

If anyone would like to be involved in testing or expanding the user friendly interface, please contact the maintainer.

Feedback on the documentation, bugs, usability, or additional features desired is welcome. Time and person-power permitting the most commonly requested features will be implemented.

SEE ALSO ^

Below is a review of subversion related resource on and off CPAN. This list was constructed in early February, 2011.

Background information

Tools for subversion application developers

Importing SWIG bindings

* Alien::SVN - the modules responsible for importing the SWIG-Perl bindings for subversion. This class would not be possible withut this module.

Friendly interfaces to the SVN bindings

* SVN::TXN::Props - extracts revision properties and stores them in a hash for use in hook scripts

* SVN::Simple - a simplified Delta editor for rolling your own commit process.

Automation of command line interface

* SVN::Agent - wrapper for command line client (svn)

* SVN::Class - wrapper for command line client (svn)

* SVN::Look - wrapper for command line tool: svnlook

* SVN::SVNLook - wrapper for command line tool: svnlook

Components for use in repository hooks

* SVN::Hooks - a framework for managing hooks and defining hooks using reusable components.

* SVN::Notify - function that can be called from a hook script. The routine monitors subversion activity and sends emails to notify people of interesting events.

* SVN::Notify::Config - configures SVN::Notify

* SVN::Notify::Mirror - extension of SVN::Notify that uses svn export and rsync or ssh to push the latest versions of repository files onto a webserver or other resource using svn export

* SVN::Notify::Snapshot - exports a snapshot of a subversion repository

* SVN::Utils::ClientIP - get client's IP address in a subversion hook

Tools for specific tasks

Repository hook and access rights management

* SVN::ACL - configure user access - writes directly to repository access configuration files without the assistance of either subversion command line tools or SWIG bindings

* SVN::Access - configure user access - writes directly to repository access configuration files without the assistance of either subversion command line tools or SWIG bindings

* SVN::Hook - a framework for install, enable, disable, and testing hook scripts.

Deployment, mirroring and working copy management

* Git::SVNReplay - replays Git commits into a throwaway SVN repository using the command line client (svn). Useful for integrating a git repository contents with tools that only know how to speak to a subversion repository.

* SVN::Mirror - mirror remote repository to a local repository uses SWIG bindings.

* SVN::Push - push changes from one respository into another using SWIG bindings.

* SVN::Pusher - push changes from one respository into another using SWIG bindings.

* SVN::S4 - utilties for managing working copies, e.g. mapping project URLs to project directories. Uses SWIG bindings.

* SVN::OpenSVN - fetches a subversion respoistory dump from the open SVN project - uses neither SWIG nor command line tools.

* Dist::Zilla::Plugin::SvnObtain - gets files from a subversion repository before building a distribution using SWIG bindings

* SVN::Deploy - building/deploying releases from a repository using SWIG bindings.

Repository content analysis

* SVN::Churn - generate graph for repository churn using SWIG bindings.

* SVN::Log - retrieves and parses commit logs using SWIG bindings.

* SVN::Log::Index - builds an index on commit logs using SVN::Log.

* SVN::Log::Accounting - tabulates information from log files into reports using SVN::Log

* App::SVN::Bisect - interactive tool for finding which revision in a subversion repository contains a particular change using the log subcommand of the command line client (svn)

* SVN::Dump - parses dumpfile without use of SWIG bindings or command line tools.

* SVN::DumpReloc - parses dumpfile without use of SWIG bindings or command line tools.

* SVN::Dumpfile - parses dumpfile without use of SWIG bindings or command line tools.

* SVN::Dumpfilter - parses dumpfile without use of SWIG bindings or command line tools.

* Parse::SVNDiff - parses and formats SVN's binary diff output. What it uses to do this is not clear. The source code is not visible via CPAN.

Interactive editors and viewers

* SVN::Web - a web interface to a subversion repository. Uses SWIG bindings.

* Catalyst::Model::SVN - Catalyst browser for subversion repositories. Uses SWIG bindings.

* Padre::Plugin::SVN - SVN access for the Padre editor. Uses command line client (svn).

AUTHOR ^

Elizabeth Grace Frank-Backman

COPYRIGHT ^

Copyright (c) 2008-2011 Elizabeth Grace Frank-Backman. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: