Skip to content

Commit

Permalink
Added archive documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
siad007 committed Aug 30, 2014
1 parent 9334fef commit fbfe57c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
17 changes: 17 additions & 0 deletions docs/commands/archive.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
Archive
=======

Creates an unversioned archive of a repository revision.

Examples:

.. code-block:: php
:linenos:
use Siad007\VersionControl\HG\Factory;
$archiveCmd = Factory::createArchive();
$archiveCmd->setDestination('C:\\xampp\\dest\\');
$archiveCmd->addInclude('includePattern');
$archiveCmd->addExclude('excludePattern');
$archiveCmd->setSubrepos(tru);
$archiveCmd->setNoDecode(true);
2 changes: 1 addition & 1 deletion docs/commands/unbundle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Examples:
$unbundleCmd->addFile('C:\\xampp\\file1\\');
$unbundleCmd->addFile('C:\\xampp\\file2\\');
$unbundleCmd->setUpdate(true);
$unbundleCmd->run();
$unbundleCmd->run();
13 changes: 0 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Contents:

commands/add
commands/addremove

commands/annotate
commands/archive
commands/backout
Expand All @@ -21,9 +20,7 @@ Contents:
commands/branches
commands/bundle
commands/cat

commands/clone

commands/commit
commands/config
commands/copy
Expand All @@ -32,7 +29,6 @@ Contents:
commands/forget
commands/graft
commands/grep

commands/heads
commands/init
commands/paths
Expand All @@ -50,7 +46,6 @@ Commands

* :doc:`commands/add`
* :doc:`commands/addremove`

* :doc:`commands/annotate`
* :doc:`commands/archive`
* :doc:`commands/backout`
Expand All @@ -60,9 +55,7 @@ Commands
* :doc:`commands/branches`
* :doc:`commands/bundle`
* :doc:`commands/cat`

* :doc:`commands/clone`

* :doc:`commands/commit`
* :doc:`commands/config`
* :doc:`commands/copy`
Expand All @@ -71,18 +64,12 @@ Commands
* :doc:`commands/forget`
* :doc:`commands/graft`
* :doc:`commands/grep`

* :doc:`commands/heads`

* :doc:`commands/help`
* :doc:`commands/identify`
* :doc:`commands/import`
* :doc:`commands/incoming`

* :doc:`commands/init`



* :doc:`commands/paths`
* :doc:`commands/pull`
* :doc:`commands/push`
Expand Down

0 comments on commit fbfe57c

Please sign in to comment.