View source for How to use SVK

== SVK Setup and Usage Instructions ==

=== Setup ===

These are steps which need to be followed to set up SVK initally, whether there is an existing SVN repository to migrate or not. Assumes a default install of [http://subversion.tigris.org/project_packages.html Subversion] and [http://svk.bestpractical.com/view/InstallingSVK SVK]. More information can be found in the book [http://svkbook.elixus.org/index.en.html Version Control with SVK].

# <code>svk depotmap --init</code>
#*''<font color="blue">Initializes SVK.</font>''
# <code>svk mirror svn://user@svn.parentrepository.com/project //project_parent</code><br /><code><font color="grey">Mirror initialized. Run svk sync //project_parent to start mirroring.</font></code>
#*''<font color="blue">Mirrors the parent repository to a local depot.</font>''
# <code>svk sync //project_parent</code><br /><code><font color="grey">Syncing svn://user@svn.parentrepository.com/project<br /> Retrieving log information from 1 to 134<br /> Committed revision 2 from revision 1.<br /> ...<br /> Committed revision 135 from revision 134.</font></code>
#*''<font color="blue">Retrieves all the revisions of the parent repository into the local mirror. Alternatively the following can be used to ignore older revisions:</font>  <code>svk sync --skipto HEAD //project_parent</code>
# <code>svk cp //project_parent //project_new</code><br /><code><font color="grey">Committed revision 136.</font></code>
#*''<font color="blue">Creates a child depot based on the mirror of the parent repository. SVK will know henceforth that the child is related to the parent.</font>''
# <code>svnserve -d -r /path/to/.svk/local</code>
#*''<font color="blue">Begin serving the SVK depots via the SVN protocol. Not necessary if serving the depot via HTTP over Apache or only accessing the depot childly via the <code>file://</code> protocol.</font>''
# <code>svn co svn://childhost/project_new /path/to/working/copy/of/project</code>
#*''<font color="blue">Use Subversion tools to check out a working copy of the child depot. This working copy can be operated upon normally with SVN tools - commit, update, etc.</font>''

=== Migrating an Existing Repository ===

These are steps which need to be followed when a previously existing SVN repository needs to be migrated to SVK. Assumes the setup steps above have been completed.

# <code>svk mirror svn://user@childrepositoryhost/project_old //project_old</code><br /><code><font color="grey">Mirror initialized. Run svk sync //project_old to start mirroring.</font></code>
#*''<font color="blue">Mirror the old repository (which must have been based on the parent repository at some point) to an SVK depot.</font>''
# <code>svk sync //project_old</code><br /><code><font color="grey">Syncing svn://user@childrepositoryhost/project_old<br /> Retrieving log information from 1 to 6<br /> Committed revision 138 from revision 1.<br /> ...<br /> Committed revision 143 from revision 6.</font></code>
#*''<font color="blue">Retrieve all the revisions of the old SVN repository into the SVK depot mirror of the old repository.</font>''
# <code>kill <span><font color="red">1234</font></span></code>
#*''<font color="blue">Kill the svnserve process which is serving the old SVN repository. Substitute the correct process ID.</font>''
# <code>svk merge -r <span><font color="red">138:143</font></span> -l //project_old //project_new</code><br /><code><font color="grey">Committed revision 144.</font></code>
#*''<font color="blue">Merge the revisions from the SVK depot which mirrors the old repository into the child depot (which is a copy of the mirror depot of the parent repository). All revisions will be imported in one commit - incremental revision merges don't seem to be supported by SVK at the time of writing (using the <code>-I</code> switch results in an error). Note that the revision numbers above apply to the SVK revisions, not the SVN revisions from the old SVN repository.</font>''
# <code>svk mirror -d //project_old</code><br /><code><font color="grey">Mirror path '//project_old' detached.</font></code>
#*''<font color="blue">Remove the now-unneeded mirror of the old SVN repository (optional).</font>''
# <code>svn up /path/to/working/copy/of/project</code>
#*''<font color="blue">Update the working copy of the child depot with the change containing all the revisions from the old SVN repository.</font>''

=== Migrating Changes Between the Parent Mirror and the Child Depot ===

* To pull all changes from the parent repository into the mirror, and push all changes from the mirror into the parent repository:
<code>svk sync //project_parent</code>
* As above, but only up to a specific revision:
<code>svk sync -t <span><font color="red">133</font></span> //project_parent</code>
* To merge a specific revision range from the parent depot (mirror) to the child depot (copy of mirror):
<code>svk merge -r <span><font color="red">1000:1050</font></span> //project_parent //project_child</code> (<font color="blue">Note that the revision numbers refer to the SVK depot revision numbers, not the revision numbers of the parent repository.</font>)
* To auto-merge all changes from the parent depot to the child depot:
<code>svk smerge //project_parent //project_child</code>
or
<code>svk pull //project_child</code>
* As above, synchronizing the parent mirror first:
<code>svk smerge -s //project_parent //project_child</code>