git-svn: update documentation for multi-{init|fetch}
Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
Eric Wong committed
Jan 4, 2007 at 18:04 UTC
0d313b2b7bb219542473a25ad042f4b990e69a45
1 file changed
+37
-17
Documentation/git-svn.txt
+37
-17
@@ -3,7 +3,7 @@ git-svn(1)
3
4
NAME
5
----
6
-git-svn - bidirectional operation between a single Subversion branch and git
6
+git-svn - bidirectional operation between Subversion and git
7
8
SYNOPSIS
9
--------
@@ -11,24 +11,20 @@ SYNOPSIS
11
12
DESCRIPTION
13
-----------
14
-git-svn is a simple conduit for changesets between a single Subversion
15
-branch and git. It is not to be confused with gitlink:git-svnimport[1].
16
-They were designed with very different goals in mind.
14
+git-svn is a simple conduit for changesets between Subversion and git.
15
+It is not to be confused with gitlink:git-svnimport[1], which is
16
+read-only and geared towards tracking multiple branches.
17
18
-git-svn is designed for an individual developer who wants a
18
+git-svn was originally designed for an individual developer who wants a
19
bidirectional flow of changesets between a single branch in Subversion
20
-and an arbitrary number of branches in git. git-svnimport is designed
21
-for read-only operation on repositories that match a particular layout
22
-(albeit the recommended one by SVN developers).
20
+and an arbitrary number of branches in git. Since its inception,
21
+git-svn has gained the ability to track multiple branches in a manner
22
+similar to git-svnimport; but it cannot (yet) automatically detect new
23
+branches and tags like git-svnimport does.
24
24
-For importing svn, git-svnimport is potentially more powerful when
25
-operating on repositories organized under the recommended
26
-trunk/branch/tags structure, and should be faster, too.
27
-
28
-git-svn mostly ignores the very limited view of branching that
29
-Subversion has. This allows git-svn to be much easier to use,
30
-especially on repositories that are not organized in a manner that
31
-git-svnimport is designed for.
25
+git-svn is especially useful when it comes to tracking repositories
26
+not organized in the way Subversion developers recommend (trunk,
27
+branches, tags directories).
28
29
COMMANDS
30
--------
@@ -370,7 +366,7 @@ SVN was very wrong.
366
Basic Examples
367
~~~~~~~~~~~~~~
368
373
-Tracking and contributing to a Subversion-managed project:
369
+Tracking and contributing to a the trunk of a Subversion-managed project:
370
371
------------------------------------------------------------------------
372
# Initialize a repo (like git init-db):
@@ -388,6 +384,30 @@ Tracking and contributing to a Subversion-managed project:
384
git-svn show-ignore >> .git/info/exclude
385
------------------------------------------------------------------------
386
387
+Tracking and contributing to an entire Subversion-managed project
388
+(complete with a trunk, tags and branches):
389
+See also:
390
+'<<tracking-multiple-repos,Tracking Multiple Repositories or Branches>>'
391
+
392
+------------------------------------------------------------------------
393
+# Initialize a repo (like git init-db):
394
+ git-svn multi-init http://svn.foo.org/project \
395
+ -T trunk -b branches -t tags
396
+# Fetch remote revisions:
397
+ git-svn multi-fetch
398
+# Create your own branch of trunk to hack on:
399
+ git checkout -b my-trunk remotes/trunk
400
+# Do some work, and then commit your new changes to SVN, as well as
401
+# automatically updating your working HEAD:
402
+ git-svn dcommit -i trunk
403
+# Something has been committed to trunk, rebase the latest into your branch:
404
+ git-svn multi-fetch && git rebase remotes/trunk
405
+# Append svn:ignore settings of trunk to the default git exclude file:
406
+ git-svn show-ignore -i trunk >> .git/info/exclude
407
+# Check for new branches and tags (no arguments are needed):
408
+ git-svn multi-init
409
+------------------------------------------------------------------------
410
+
411
REBASE VS. PULL
412
---------------
413