Manual Pages for UNIX Darwin command on man SVK::XD

SVK::XD(3) User Contributed Perl Documentation SVK::XD(3)

NAME

SVK::XD - svk depot and checkout handling.

SYNOPSIS

use SVK::XD;

$xd = SVK::XD->new (depotmap => { '' => '/path/to/repos'});

TTEERRMMIINNOOLLOOGGYY depot A repository referred by a name. The default depot is '' (the empty string). depotpath A path referred by a depot name and the path inside the depot. For example, //foo/bar means /foo/bar in the default depot '', and /test/foo/bar means /foo/bar in the depot tteesstt. copath Checkout path. A path in the file system that has a checked out version of a certain depotpath. CCOONNSSTTRRUUCCTTOORR Options to "new": depotmap A hash reference for depot name and repository path mapping. checkout A Data::Hierarchy object for checkout paths mapping. giantlock A filename for global locking. This file protects all read and write accesses to the "statefile". When SVK begins to execute any command, it attempt to get a write lock on this "giant lock" file. Once it gets the lock, it writes its PID to the file, reads in its "statefile", and begins to execute the command. Executing the command consists of a "lock" phase and a "run" phase. During the lock phase, a command can do one of three things: request to keep the giant lock for the entire execution (for commands which modify large parts of the "statefile"), request to lock individual checkout paths, or not request a lock. In the first case, the command sets the "holdgiant" field on the SVK::Command object (this should probably change to a real API), and the command does not release the giant lock until it is finished; it can rewrite the "statefile" at the end of its execution without waiting on the lock, since it already holds it.

In the second case, the command calls "lock" on the SVK::XD object

one or more times; this places a "lock" entry inside the Data::Hierarchy object in the statefile next to each locked path, unless they are already locked by another process. Between its lock phase and its run phase, the "statefile" is written to disk (with the new "lock" entries) and the giant lock is dropped. After the run phase, SVK acquires the giant lock again, reads in the "statefile", copies all entries from the paths that it has locked into the version it just read, clears the lock entries from the hierarchy, writes the "statefile" to disk, and drops the giant lock. Any changes to the hierarchy other than in the locked paths will be ignored. In the third case, SVK just drops the giant lock after the lock phase and never tries to read or write the "statefile" again. statefile

Filename for serializing "SVK::XD" object.

svkpath Directory name of "giantlock" and "statefile". MMEETTHHOODDSS SSeerriiaalliizzaattiioonn aanndd lloocckkiinngg load

Load the serialized "SVK::XD" data from statefile. Initialize $self

if there's nothing to load. The giant lock is acquired when calling "load". store store

Serialize $self to the statefile. If giant lock is still ours,

overwrite the file directly. Otherwise load the file again and merge the paths we locked into the new state file. After "store" is called, giant is unlocked. lock Lock the given checkout path, store the state with the lock info to prevent other instances from modifying locked paths. unlock Unlock all the checkout paths that were locked by this instance. giantlock Lock the statefile globally. All other instances need to wait for the lock before they can do anything. giantunlock Release the giant lock. DDeeppoott aanndd ppaatthh ttrraannssllaattiioonn findrepos Given depotpath and an option about if the repository should be opened. Returns an array of repository path, the path inside repository, and the "SVN::Repos" object if caller wants the repository to be opened. findreposfromco Given the checkout path and an option about if the repository should be opened. Returns an array of repository path, the path inside repository, the absolute checkout path, the checkout info, and the "SVN::Repos" object if caller wants the repository to be opened. findreposfromcomaybe Like "findreposfromco", but falls back to see if the given path is a depotpath. In that case, the checkout paths returned iwll be undef. finddepotname CChheecckkoouutt hhaannddlliinngg autoprop Return a hash of properties that should attach to the file automatically when added. depotdelta Generate "SVN::Delta::Editor" calls to represent the changes between "(oldroot, oldpath)" and "(newroot, newpath)". oldpath is a array ref for anchor and target, newpath is just a string. Options: editor The editor receiving delta calls. notextdelta Don't generate text deltas in "applytextdelta" calls. norecurse noticeancestry checkoutdelta Generate "SVN::Delta::Editor" calls to represent the local changes made to the checked out revision. Options: deleteverbose

Generate deleteentry calls for sub-entries within deleted

entry. absentverbose

Generate absent* calls for sub-entries within absent entry.

unknownverbose

generate cbunknown calls for sub-entries within absent entry.

absentignore Don't generate absent* calls. expandcopy Mimic the behavior like SVN::Repos::dirdelta, lose copy information and treat all copied descendents as added too. cbignored Called for ignored items if defined. cbunchanged Called for unchanged files if defined.

getentry($copath)

Returns the Data::Hierarchy entry and the schedule of the entry. getfh

Returns a file handle with keyword translation and line-ending

layers attached. getprops Returns the properties associated with a node. Properties schedule

for commit are merged if $copath is given.