Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Toader::VCS(3)	      User Contributed Perl Documentation	Toader::VCS(3)

NAME
       Toader::VCS - Handles the VCS integration for Toader.

VERSION
       Version 0.0.1

METHODS
   new
       This intiates the object.

       One argument is accepted	and that is to Toader object to	use.

	   my $tvcs=Toader::VCS->new($toader);
	   if (	$tvcs->error ){
	       warn('Error:'$tvcs->error.':'.$tvcs->errorFlag.': '.$tvcs->errorString);
	   }

   add
       This adds a file	or directory.

       One option is accepted and that what is to be added.

	   $tvcs->add($someFile);
	   if (	$tvcs->error ){
	       warn('Error:'$tvcs->error.':'.$tvcs->errorFlag.': '.$tvcs->errorString);
	   }

   delete
       This deletes a file or directory.

       One option is accepted and that what is to be deleted.

	   $tvcs->delete($someFile);
	   if (	$tvcs->error ){
	       warn('Error:'$tvcs->error.':'.$tvcs->errorFlag.': '.$tvcs->errorString);
	   }

   underVCS
       This checks if something	is under VCS.

       The returned value is a Perl boolean.

	   my $underVCS=$tvcs->underVCS($someFile);
	   if (	$tvcs->error ){
	       warn('Error:'$tvcs->error.':'.$tvcs->errorFlag.': '.$tvcs->errorString);
	   }

   usable
       Checks if this object is	usable or not.

	   $tvcs->usable;

ERROR CODES/FLAGS/HANDLING
       Error handling is provided by Error::Helper.

   1, noToader
       No Toader object	specified.

   2, notToader
       The object specified is not a Toader object.

   3, getConfigFailed
       Failed to read the .toader/config.ini .

   4, nothingToAdd
       Nothing specified to add.

   5, doesNotExist
       What is to be added does	not exist

   6, notFileOrDir
       The specified item is not a file	or directory.

   7, configNotUsable
       The configuration is not	usable.

       This most likely	means either a config value is missing or it is
       disabled, such as in the	example	below.

	   vcs=0
	   [VCS]
	   addExec=svn add --parents %%%item%%%	> /dev/null
	   deleteExec=svn del %%%item%%% > /dev/null
	   underVCSexec=svn info %%%info%%% > /dev/null

   8, nonZeroExit
       One of the commands to execute returned a non-zero status.

   9, getVCSfailed
       Toader->getVCS errored.

AUTHOR
       Zane C. Bowers-Hadley, "<vvelox at vvelox.net>"

BUGS
       Please report any bugs or feature requests to "bug-toader at
       rt.cpan.org", or	through	the web	interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>.	 I will	be
       notified, and then you'll automatically be notified of progress on your
       bug as I	make changes.

SUPPORT
       You can find documentation for this module with the perldoc command.

	   perldoc Toader::VCS

       You can also look for information at:

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Toader>

       o   CPAN	Ratings

	   <http://cpanratings.perl.org/d/Toader>

       o   Search CPAN

	   <http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS
LICENSE	AND COPYRIGHT
       Copyright 2013 Zane C. Bowers-Hadley.

       This program is free software; you can redistribute it and/or modify it
       under the terms of either: the GNU General Public License as published
       by the Free Software Foundation;	or the Artistic	License.

       See http://dev.perl.org/licenses/ for more information.

perl v5.24.1			  2013-07-20			Toader::VCS(3)

NAME | VERSION | METHODS | ERROR CODES/FLAGS/HANDLING | AUTHOR | BUGS | SUPPORT | ACKNOWLEDGEMENTS | LICENSE AND COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Toader::VCS&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help