Skip to content

Commit

Permalink
Added some more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
siad007 committed Oct 3, 2014
1 parent 8d9a839 commit 5eb9220
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/commands/annotate.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
Annotate
========

Shows changeset information by line for each file.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$annotateCmd = Factory::createAnnotate();
$annotateCmd->addFile('C:\\xampp\\file1\\');
$annotateCmd->addFile('C:\\xampp\\file2\\');
$annotateCmd->setNoFollow(true);
20 changes: 20 additions & 0 deletions docs/commands/backout.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
Backout
=======

Reverses effect of earlier changeset.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$backoutCmd = Factory::createBackout();
$backoutCmd->setRevision('revision');
$backoutCmd->setMerge(true);
$backoutCmd->setTool('tool');
$backoutCmd->addInclude('includePattern');
$backoutCmd->addExclude('excludePattern');
$backoutCmd->setMessage('text');
$backoutCmd->setLogfile('logfile');
$backoutCmd->setDate('date');
$backoutCmd->setUser('user');
13 changes: 13 additions & 0 deletions docs/commands/bisect.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
Bisect
======

Shows changeset information by line for each file.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$bisecCmd = Factory::createBisec();
$bisecCmd->setBad(true);
$bisecCmd->setExtend(true);
14 changes: 14 additions & 0 deletions docs/commands/bookmarks.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
Bookmarks
=========

Tracks a line of development with movable markers.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$bookmarksCmd = Factory::createBookmarks();
$bookmarksCmd->addName('test');
$bookmarksCmd->setRev('revision');
$bookmarksCmd->setForce(true);
14 changes: 14 additions & 0 deletions docs/commands/branch.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
Branch
======

Sets or shows the current branch name.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$branchCmd = Factory::createBranch();
$branchCmd->setName('test');
$branchCmd->setClean(true);
$branchCmd->setForce(true);

0 comments on commit 5eb9220

Please sign in to comment.