contrib/git-svn: documentation updates
contrib/git-svn/git-svn.txt: added git-repo-config key names for options fixed quoting of "git-svn-HEAD" in the manpage use preformatted text for examples contrib/git-svn/Makefile: add target to generate HTML: http://git-svn.yhbt.net/git-svn.html Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
Eric Wong committed
Apr 1, 2006 at 18:25 UTC
20b1d700c94c8b5b2b8b6f1b4982858d03cd9453
2 files changed
+31
-13
contrib/git-svn/Makefile
+3
@@ -25,6 +25,9 @@ git-svn.1 : git-svn.xml
25
git-svn.xml : git-svn.txt
26
asciidoc -b docbook -d manpage \
27
-f ../../Documentation/asciidoc.conf $<
28
+git-svn.html : git-svn.txt
29
+ asciidoc -b xhtml11 -d manpage \
30
+ -f ../../Documentation/asciidoc.conf $<
31
test:
32
cd t && $(SHELL) ./t0000-contrib-git-svn.sh
33
contrib/git-svn/git-svn.txt
+28
-13
@@ -101,6 +101,8 @@ OPTIONS
101
cannot version empty directories. Enabling this flag will make
102
the commit to SVN act like git.
103
104
+ repo-config key: svn.rmdir
105
+
106
-e::
107
--edit::
108
Only used with the 'commit' command.
@@ -109,6 +111,8 @@ OPTIONS
111
default for objects that are commits, and forced on when committing
112
tree objects.
113
114
+ repo-config key: svn.edit
115
+
116
-l<num>::
117
--find-copies-harder::
118
Both of these are only used with the 'commit' command.
@@ -116,6 +120,9 @@ OPTIONS
120
They are both passed directly to git-diff-tree see
121
git-diff-tree(1) for more information.
122
123
+ repo-config key: svn.l
124
+ repo-config key: svn.findcopiesharder
125
+
126
ADVANCED OPTIONS
127
----------------
128
-b<refname>::
@@ -133,6 +140,8 @@ ADVANCED OPTIONS
140
This option may be specified multiple times, once for each
141
branch.
142
143
+ repo-config key: svn.branch
144
+
145
-i<GIT_SVN_ID>::
146
--id <GIT_SVN_ID>::
147
This sets GIT_SVN_ID (instead of using the environment). See
@@ -145,7 +154,7 @@ COMPATIBILITY OPTIONS
154
Only used with the 'rebuild' command.
155
156
Run this if you used an old version of git-svn that used
148
- 'git-svn-HEAD' instead of 'remotes/git-svn' as the branch
157
+ "git-svn-HEAD" instead of "remotes/git-svn" as the branch
158
for tracking the remote.
159
160
--no-ignore-externals::
@@ -162,25 +171,29 @@ COMPATIBILITY OPTIONS
171
Otherwise, do not enable this flag unless you know what you're
172
doing.
173
174
+ repo-config key: svn.noignoreexternals
175
+
176
Basic Examples
177
~~~~~~~~~~~~~~
178
179
Tracking and contributing to an Subversion managed-project:
180
170
-# Initialize a tree (like git init-db)::
181
+------------------------------------------------------------------------
182
+# Initialize a tree (like git init-db):
183
git-svn init http://svn.foo.org/project/trunk
172
-# Fetch remote revisions::
184
+# Fetch remote revisions:
185
git-svn fetch
174
-# Create your own branch to hack on::
186
+# Create your own branch to hack on:
187
git checkout -b my-branch remotes/git-svn
176
-# Commit only the git commits you want to SVN::
188
+# Commit only the git commits you want to SVN:
189
git-svn commit <tree-ish> [<tree-ish_2> ...]
178
-# Commit all the git commits from my-branch that don't exist in SVN::
190
+# Commit all the git commits from my-branch that don't exist in SVN:
191
git-svn commit remotes/git-svn..my-branch
180
-# Something is committed to SVN, pull the latest into your branch::
192
+# Something is committed to SVN, pull the latest into your branch:
193
git-svn fetch && git pull . remotes/git-svn
182
-# Append svn:ignore settings to the default git exclude file::
194
+# Append svn:ignore settings to the default git exclude file:
195
git-svn show-ignore >> .git/info/exclude
196
+------------------------------------------------------------------------
197
198
DESIGN PHILOSOPHY
199
-----------------
@@ -219,7 +232,7 @@ git commits with the following syntax:
232
233
This allows you to tie unfetched SVN revision 375 to your current HEAD::
234
222
- git-svn fetch 375=$(git-rev-parse HEAD)
235
+ `git-svn fetch 375=$(git-rev-parse HEAD)`
236
237
Advanced Example: Tracking a Reorganized Repository
238
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -232,22 +245,24 @@ This is how Yann Dirson tracked the trunk of the ufoai directory when
245
the /trunk directory of his repository was moved to /ufoai/trunk and
246
he needed to continue tracking /ufoai/trunk where /trunk left off.
247
235
- # This log message shows when the repository was reorganized::
248
+------------------------------------------------------------------------
249
+ # This log message shows when the repository was reorganized:
250
r166 | ydirson | 2006-03-02 01:36:55 +0100 (Thu, 02 Mar 2006) | 1 line
251
Changed paths:
252
D /trunk
253
A /ufoai/trunk (from /trunk:165)
254
241
- # First we start tracking the old revisions::
255
+ # First we start tracking the old revisions:
256
GIT_SVN_ID=git-oldsvn git-svn init \
243
- https://svn.sourceforge.net/svnroot/ufoai/trunk
257
+ https://svn.sourceforge.net/svnroot/ufoai/trunk
258
GIT_SVN_ID=git-oldsvn git-svn fetch -r1:165
259
246
- # And now, we continue tracking the new revisions::
260
+ # And now, we continue tracking the new revisions:
261
GIT_SVN_ID=git-newsvn git-svn init \
262
https://svn.sourceforge.net/svnroot/ufoai/ufoai/trunk
263
GIT_SVN_ID=git-newsvn git-svn fetch \
264
166=`git-rev-parse refs/remotes/git-oldsvn`
265
+------------------------------------------------------------------------
266
267
BUGS
268
----