VersionControl_HG Documentation Release 0.0.1 Siad Ardroumli Jul 14, 2017
Contents 1 Add 3 2 Addremove 5 3 Annotate 7 4 Archive 9 5 Backout 11 6 Bisect 13 7 Bookmarks 15 8 Branch 17 9 Branches 19 10 Bundle 21 11 Cat 23 12 Clone 25 13 Commit 27 14 Heads 29 15 Init 31 16 Paths 33 17 Pull 35 18 Push 37 19 Root 39 20 Summary 41 i
21 Unbundle 43 22 Update 45 23 Verify 47 24 Version 49 25 Commands 51 26 Api docs: 53 27 Indices and tables 55 ii
VersionControl_HG Documentation, Release 0.0.1 VersionControl_HG is a library that provides an OO interface to handle Mercurial repositories. Contents: Contents 1
VersionControl_HG Documentation, Release 0.0.1 2 Contents
CHAPTER 1 Add Adds the specified files on the next commit. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $addcmd = Factory::createAdd(); 4 $addcmd->execute(); 3
VersionControl_HG Documentation, Release 0.0.1 4 Chapter 1. Add
CHAPTER 2 Addremove Adds all new files and delete all missing files. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $addremovecmd = Factory::createAddremove(); 4 $addremovecmd->execute(); 5
VersionControl_HG Documentation, Release 0.0.1 6 Chapter 2. Addremove
CHAPTER 3 Annotate Shows changeset information by line for each file. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $annotatecmd = Factory::createAnnotate(); 4 $annotatecmd->addfile('c:\\xampp\\file1\\'); 5 $annotatecmd->addfile('c:\\xampp\\file2\\'); 6 $annotatecmd->setnofollow(true); 7
VersionControl_HG Documentation, Release 0.0.1 8 Chapter 3. Annotate
CHAPTER 4 Archive Creates an unversioned archive of a repository revision. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $archivecmd = Factory::createArchive(); 4 $archivecmd->setdestination('c:\\xampp\\dest\\'); 5 $archivecmd->addinclude('includepattern'); 6 $archivecmd->addexclude('excludepattern'); 7 $archivecmd->setsubrepos(tru); 8 $archivecmd->setnodecode(true); 9 $archivecmd->execute(); 9
VersionControl_HG Documentation, Release 0.0.1 10 Chapter 4. Archive
CHAPTER 5 Backout Reverses effect of earlier changeset. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $backoutcmd = Factory::createBackout(); 4 $backoutcmd->setrevision('revision'); 5 $backoutcmd->setmerge(true); 6 $backoutcmd->settool('tool'); 7 $backoutcmd->addinclude('includepattern'); 8 $backoutcmd->addexclude('excludepattern'); 9 $backoutcmd->setmessage('text'); 10 $backoutcmd->setlogfile('logfile'); 11 $backoutcmd->setdate('date'); 12 $backoutcmd->setuser('user'); 11
VersionControl_HG Documentation, Release 0.0.1 12 Chapter 5. Backout
CHAPTER 6 Bisect Shows changeset information by line for each file. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $biseccmd = Factory::createBisec(); 4 $biseccmd->setbad(true); 5 $biseccmd->setextend(true); 13
VersionControl_HG Documentation, Release 0.0.1 14 Chapter 6. Bisect
CHAPTER 7 Bookmarks Tracks a line of development with movable markers. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $bookmarkscmd = Factory::createBookmarks(); 4 $bookmarkscmd->addname('test'); 5 $bookmarkscmd->setrev('revision'); 6 $bookmarkscmd->setforce(true); 15
VersionControl_HG Documentation, Release 0.0.1 16 Chapter 7. Bookmarks
CHAPTER 8 Branch Sets or shows the current branch name. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $branchcmd = Factory::createBranch(); 4 $branchcmd->setname('test'); 5 $branchcmd->setclean(true); 6 $branchcmd->setforce(true); 17
VersionControl_HG Documentation, Release 0.0.1 18 Chapter 8. Branch
CHAPTER 9 Branches 19
VersionControl_HG Documentation, Release 0.0.1 20 Chapter 9. Branches
CHAPTER 10 Bundle Creates a changegroup file Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $bundlecmd = Factory::createBundle(); 4 $bundlecmd->setfile('c:\\xampp\\file\\'); 5 $bundlecmd->setssh('testssh'); 6 $bundlecmd->setinsecure(true); 7 $bundlecmd->setverbose(true); 8 $bundlecmd->setencoding('utf-8'); 9 $bundlecmd->execute(); 21
VersionControl_HG Documentation, Release 0.0.1 22 Chapter 10. Bundle
CHAPTER 11 Cat 23
VersionControl_HG Documentation, Release 0.0.1 24 Chapter 11. Cat
CHAPTER 12 Clone Makes a copy of an existing repository. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $clonecmd = Factory::createClone(); 4 $clonecmd->setsource('/path/to/source'); 5 $clonecmd->execute(); 25
VersionControl_HG Documentation, Release 0.0.1 26 Chapter 12. Clone
CHAPTER 13 Commit Commitss the specified files and delete all missing files. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $commitcmd = Factory::createCommit(); 4 $commitcmd->setaddremove(true); 5 $commitcmd->setclosebranch(true); 6 $commitcmd->setmessage('first commit.'); 7 $commitcmd->setsubrepos(true); 27
VersionControl_HG Documentation, Release 0.0.1 28 Chapter 13. Commit
CHAPTER 14 Heads Shows branch heads. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $headscmd = Factory::createHeads(); 4 $headscmd->execute(); 29
VersionControl_HG Documentation, Release 0.0.1 30 Chapter 14. Heads
CHAPTER 15 Init Creates a new repository in the given directory. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $initcmd = Factory::createInit(); 4 $initcmd->setdestination('/path/to/destination'); 5 $initcmd->execute(); 31
VersionControl_HG Documentation, Release 0.0.1 32 Chapter 15. Init
CHAPTER 16 Paths Shows aliases for remote repositories. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $pathscmd = Factory::createPaths(); 4 $pathscmd->execute(); 33
VersionControl_HG Documentation, Release 0.0.1 34 Chapter 16. Paths
CHAPTER 17 Pull 35
VersionControl_HG Documentation, Release 0.0.1 36 Chapter 17. Pull
CHAPTER 18 Push 37
VersionControl_HG Documentation, Release 0.0.1 38 Chapter 18. Push
CHAPTER 19 Root Prints the root (top) of the current working directory. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $rootcmd = Factory::createRoot(); 4 $rootcmd->execute(); 39
VersionControl_HG Documentation, Release 0.0.1 40 Chapter 19. Root
CHAPTER 20 Summary Summarizes the working directory state. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $summarycmd = Factory::createSummary(); 4 $summarycmd->execute(); 41
VersionControl_HG Documentation, Release 0.0.1 42 Chapter 20. Summary
CHAPTER 21 Unbundle Applies one or more changegroup files. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $unbundlecmd = Factory::createUnbundle(); 4 $unbundlecmd->addfile('c:\\xampp\\file1\\'); 5 $unbundlecmd->addfile('c:\\xampp\\file2\\'); 6 $unbundlecmd->setupdate(true); 7 $unbundlecmd->execute(); 43
VersionControl_HG Documentation, Release 0.0.1 44 Chapter 21. Unbundle
CHAPTER 22 Update Updates working directory (or switches revisions) Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $updatecmd = Factory::createUpdate(); 4 $updatecmd->setclean(true); 5 $updatecmd->execute(); 45
VersionControl_HG Documentation, Release 0.0.1 46 Chapter 22. Update
CHAPTER 23 Verify Verifies the integrity of the repository. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $verifycmd = Factory::createVerify(); 4 $verifycmd->execute(); 47
VersionControl_HG Documentation, Release 0.0.1 48 Chapter 23. Verify
CHAPTER 24 Version Outputs version and copyright informations. Examples: 1 use Siad007\VersionControl\HG\Factory; 2 3 $versioncmd = Factory::createVersion(); 4 $versioncmd->execute(); 49
VersionControl_HG Documentation, Release 0.0.1 50 Chapter 24. Version
CHAPTER 25 Commands Add Addremove Annotate Archive Backout Bisect Bookmarks Branch Branches Bundle Cat Clone Commit commands/config commands/copy commands/diff commands/export commands/forget commands/graft commands/grep Heads commands/help 51
VersionControl_HG Documentation, Release 0.0.1 commands/identify commands/import commands/incoming Init Paths Pull Push Root Summary Unbundle Update Verify Version 52 Chapter 25. Commands
CHAPTER 26 Api docs: API docs are generated by phpdocumentor 2. 53
VersionControl_HG Documentation, Release 0.0.1 54 Chapter 26. Api docs:
CHAPTER 27 Indices and tables Welcome to VersionControl_HG s documentation! genindex search 55