1SVK::Help::Intro(3) User Contributed Perl Documentation SVK::Help::Intro(3)
2
6 svk is an open source distributed version control system which is
7 designed to interoperate with Subversion. Like other version control
8 systems, it keeps track of each change you make to a project and allows
9 you to maintain multiple parallel tracks of development. svk also has
10 a number of powerful features which are rarely found in other version
11 control systems.
12 svk has been designed from the ground up to support development models
14 that are simple and intuitive for software developers. It has advanced
15 smart branching and merging semantics that make it easy to maintain
16 multiple parallel lines of development and painless to merge changes
17 across branches. svk's built in patch manager makes it easy for non-
18 committers to share changes among themselves and with project maintain‐
19 ers
20 svk provides powerful support for distributed development. Every svk
22 client is capable of fully mirroring remote Subversion repositories so
23 that you have full access to a project's history at any time, even when
24 they are off the network or on the wrong side of a firewall. You can
25 branch a remote project at any point in that project's history, whether
26 or not you have write access to that project's repository. Later, you
27 can integrate changes from the project's master server (usually with a
28 single command) or push your branch up to another Subversion reposi‐
29 tory.
30
32 svk has a rich command line interface that can be somewhat daunting at
33 first. the following few commands are all you'll need for day to day
34 operation.
35 svk mirror
37 First, you'll need to mirror a remote repository. This sets up a
38 local copy of that repository for you to branch from, merge to and
39 otherwise poke at. The local path is sometimes called a "depot
40 path."
41 # This command sets up the mirror directory for your local
43 # mirrors of remote repositories
44 svk mkdir //mirror
45 svk mirror svn://svn.example.com/project_x //mirror/project_x
47 svk sync
49 When you've set up a new mirror or want to get some work done with‐
50 out a network connection, sync your local repository with upstream
51 repositories.
52 svk sync //mirror/project_x
54 svk copy
56 After that, it's easy to copy remote branches to create local
57 branches. (svk branches are simply directories, just like Subver‐
58 sion branches.)
59 # This command sets up a directory for your local branches.
61 # Local branches can't live inside mirrored paths
62 svk mkdir //local
63 svk copy //mirror/project_x //local/project_x
65 svk checkout
67 When you want to get some work done, you can checkout a working
68 copy to make local changes.
69 cd ~/svk-checkouts
71 svk co //local/project_x
72 svk add, svk delete and svk move
74 As you work on the files in your working copy, feel free to add new
75 files, delete existing files and move files around.
76 cd ~/svk-checkouts/project_x
78 svk add Changelog
80 svk move badly_named_file.c well_named_file.c
81 svk delete .README.swp
82 svk commit
84 When you're done, just commit your changes to your local reposi‐
85 tory, whether or not you have network. If you commit to a mirrored
86 path, rather than a local branch, you'll need to be able to access
87 the path's upstream subversion server, but the commit will be sent
88 to the server instantly.
89 svk commit
91 svk pull
93 Life doesn't stop when you make a local branch. From time to time,
94 pull down changes from the upstream repository.
95 svk pull //local/project_x
97 svk push
99 When you're ready to share your changes with the world, push them
100 to the upstream repository.
101 svk push //local/project_x
103 To see a full list of svk's commands, type "svk help commands". For
105 help with a specific command, just type "svk help command".
106 The svk wiki (<http://svk.bestpractical.com>) is a great place to find
108 the latest svk tips, tricks and updates. If you run into trouble using
109 svk, the wiki's the right place to start looking for help.
110perl v5.8.8 2006-12-28 SVK::Help::Intro(3)