@matheusbsbs / matheus-bagliano / commits / 0ea4d4c94b
Fork 0

git-svn(1): improve asciidoc markup

Use list continuation to have better wrapping. This accounts for most of the changes because it reindents a lot of text without applying other changes. Use cross-referencing for interlinking and the gitlink macro for pointing to other tools in the git suite. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>

Jonas Fonseca committed Aug 25, 2006 at 03:07 UTC 0ea4d4c94b7662c9668d30d8441c1a9a3376d772
1 file changed +114 -85
Documentation/git-svn.txt
+114 -85
@@ -12,10 +12,8 @@ SYNOPSIS
12 DESCRIPTION
13 -----------
14 git-svn is a simple conduit for changesets between a single Subversion
15 -branch and git.
16 -
17 -git-svn is not to be confused with git-svnimport. The were designed
18 -with very different goals in mind.
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.
17
18 git-svn is designed for an individual developer who wants a
19 bidirectional flow of changesets between a single branch in Subversion
@@ -34,26 +32,29 @@ git-svnimport is designed for.
32
33 COMMANDS
34 --------
37 -init::
35 +--
36 +
37 +'init'::
38 Creates an empty git repository with additional metadata
39 directories for git-svn. The Subversion URL must be specified
40 as a command-line argument.
41
42 -fetch::
43 - Fetch unfetched revisions from the Subversion URL we are
44 - tracking. refs/remotes/git-svn will be updated to the
45 - latest revision.
42 +'fetch'::
43
47 - Note: You should never attempt to modify the remotes/git-svn
48 - branch outside of git-svn. Instead, create a branch from
49 - remotes/git-svn and work on that branch. Use the 'commit'
50 - command (see below) to write git commits back to
51 - remotes/git-svn.
44 +Fetch unfetched revisions from the Subversion URL we are
45 +tracking. refs/remotes/git-svn will be updated to the
46 +latest revision.
47
53 - See 'Additional Fetch Arguments' if you are interested in
54 - manually joining branches on commit.
48 +Note: You should never attempt to modify the remotes/git-svn
49 +branch outside of git-svn. Instead, create a branch from
50 +remotes/git-svn and work on that branch. Use the 'commit'
51 +command (see below) to write git commits back to
52 +remotes/git-svn.
53
56 -commit::
54 +See '<<fetch-args,Additional Fetch Arguments>>' if you are interested in
55 +manually joining branches on commit.
56 +
57 +'commit'::
58 Commit specified commit or tree objects to SVN. This relies on
59 your imported fetch data being up-to-date. This makes
60 absolutely no attempts to do patching when committing to SVN, it
@@ -61,9 +62,9 @@ commit::
62 commit. All merging is assumed to have taken place
63 independently of git-svn functions.
64
64 -rebuild::
65 +'rebuild'::
66 Not a part of daily usage, but this is a useful command if
66 - you've just cloned a repository (using git-clone) that was
67 + you've just cloned a repository (using gitlink:git-clone[1]) that was
68 tracked with git-svn. Unfortunately, git-clone does not clone
69 git-svn metadata and the svn working tree that git-svn uses for
70 its operations. This rebuilds the metadata so git-svn can
@@ -71,130 +72,152 @@ rebuild::
72 specified at the command-line if the directory/repository you're
73 tracking has moved or changed protocols.
74
74 -show-ignore::
75 +'show-ignore'::
76 Recursively finds and lists the svn:ignore property on
77 directories. The output is suitable for appending to
78 the $GIT_DIR/info/exclude file.
79
80 +--
81 +
82 OPTIONS
83 -------
84 +--
85 +
86 -r <ARG>::
87 --revision <ARG>::
83 - Only used with the 'fetch' command.
88
85 - Takes any valid -r<argument> svn would accept and passes it
86 - directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
87 - is also supported. This is passed directly to svn, see svn
88 - documentation for more details.
89 +Only used with the 'fetch' command.
90 +
91 +Takes any valid -r<argument> svn would accept and passes it
92 +directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
93 +is also supported. This is passed directly to svn, see svn
94 +documentation for more details.
95
90 - This can allow you to make partial mirrors when running fetch.
96 +This can allow you to make partial mirrors when running fetch.
97
98 -::
99 --stdin::
94 - Only used with the 'commit' command.
100
96 - Read a list of commits from stdin and commit them in reverse
97 - order. Only the leading sha1 is read from each line, so
98 - git-rev-list --pretty=oneline output can be used.
101 +Only used with the 'commit' command.
102 +
103 +Read a list of commits from stdin and commit them in reverse
104 +order. Only the leading sha1 is read from each line, so
105 +git-rev-list --pretty=oneline output can be used.
106
107 --rmdir::
101 - Only used with the 'commit' command.
108
103 - Remove directories from the SVN tree if there are no files left
104 - behind. SVN can version empty directories, and they are not
105 - removed by default if there are no files left in them. git
106 - cannot version empty directories. Enabling this flag will make
107 - the commit to SVN act like git.
109 +Only used with the 'commit' command.
110 +
111 +Remove directories from the SVN tree if there are no files left
112 +behind. SVN can version empty directories, and they are not
113 +removed by default if there are no files left in them. git
114 +cannot version empty directories. Enabling this flag will make
115 +the commit to SVN act like git.
116
109 - repo-config key: svn.rmdir
117 +repo-config key: svn.rmdir
118
119 -e::
120 --edit::
113 - Only used with the 'commit' command.
121
115 - Edit the commit message before committing to SVN. This is off by
116 - default for objects that are commits, and forced on when committing
117 - tree objects.
122 +Only used with the 'commit' command.
123
119 - repo-config key: svn.edit
124 +Edit the commit message before committing to SVN. This is off by
125 +default for objects that are commits, and forced on when committing
126 +tree objects.
127 +
128 +repo-config key: svn.edit
129
130 -l<num>::
131 --find-copies-harder::
123 - Both of these are only used with the 'commit' command.
132
125 - They are both passed directly to git-diff-tree see
126 - git-diff-tree(1) for more information.
133 +Both of these are only used with the 'commit' command.
134 +
135 +They are both passed directly to git-diff-tree see
136 +gitlink:git-diff-tree[1] for more information.
137
128 - repo-config key: svn.l
129 - repo-config key: svn.findcopiesharder
138 +[verse]
139 +repo-config key: svn.l
140 +repo-config key: svn.findcopiesharder
141
142 -A<filename>::
143 --authors-file=<filename>::
144
134 - Syntax is compatible with the files used by git-svnimport and
135 - git-cvsimport:
145 +Syntax is compatible with the files used by git-svnimport and
146 +git-cvsimport:
147
148 ------------------------------------------------------------------------
138 -loginname = Joe User <user@example.com>
149 + loginname = Joe User <user@example.com>
150 ------------------------------------------------------------------------
151
141 - If this option is specified and git-svn encounters an SVN
142 - committer name that does not exist in the authors-file, git-svn
143 - will abort operation. The user will then have to add the
144 - appropriate entry. Re-running the previous git-svn command
145 - after the authors-file is modified should continue operation.
152 +If this option is specified and git-svn encounters an SVN
153 +committer name that does not exist in the authors-file, git-svn
154 +will abort operation. The user will then have to add the
155 +appropriate entry. Re-running the previous git-svn command
156 +after the authors-file is modified should continue operation.
157
147 - repo-config key: svn.authors-file
158 +repo-config key: svn.authors-file
159 +
160 +--
161
162 ADVANCED OPTIONS
163 ----------------
164 +--
165 +
166 -b<refname>::
167 --branch <refname>::
153 - Used with 'fetch' or 'commit'.
168 +Used with 'fetch' or 'commit'.
169
155 - This can be used to join arbitrary git branches to remotes/git-svn
156 - on new commits where the tree object is equivalent.
170 +This can be used to join arbitrary git branches to remotes/git-svn
171 +on new commits where the tree object is equivalent.
172
158 - When used with different GIT_SVN_ID values, tags and branches in
159 - SVN can be tracked this way, as can some merges where the heads
160 - end up having completely equivalent content. This can even be
161 - used to track branches across multiple SVN _repositories_.
173 +When used with different GIT_SVN_ID values, tags and branches in
174 +SVN can be tracked this way, as can some merges where the heads
175 +end up having completely equivalent content. This can even be
176 +used to track branches across multiple SVN _repositories_.
177
163 - This option may be specified multiple times, once for each
164 - branch.
178 +This option may be specified multiple times, once for each
179 +branch.
180
166 - repo-config key: svn.branch
181 +repo-config key: svn.branch
182
183 -i<GIT_SVN_ID>::
184 --id <GIT_SVN_ID>::
170 - This sets GIT_SVN_ID (instead of using the environment). See
171 - the section on "Tracking Multiple Repositories or Branches" for
172 - more information on using GIT_SVN_ID.
185 +
186 +This sets GIT_SVN_ID (instead of using the environment). See the
187 +section on
188 +'<<tracking-multiple-repos,Tracking Multiple Repositories or Branches>>'
189 +for more information on using GIT_SVN_ID.
190 +
191 +--
192
193 COMPATIBILITY OPTIONS
194 ---------------------
195 +--
196 +
197 --upgrade::
177 - Only used with the 'rebuild' command.
198 +Only used with the 'rebuild' command.
199
179 - Run this if you used an old version of git-svn that used
180 - "git-svn-HEAD" instead of "remotes/git-svn" as the branch
181 - for tracking the remote.
200 +Run this if you used an old version of git-svn that used
201 +"git-svn-HEAD" instead of "remotes/git-svn" as the branch
202 +for tracking the remote.
203
204 --no-ignore-externals::
184 - Only used with the 'fetch' and 'rebuild' command.
205 +Only used with the 'fetch' and 'rebuild' command.
206 +
207 +By default, git-svn passes --ignore-externals to svn to avoid
208 +fetching svn:external trees into git. Pass this flag to enable
209 +externals tracking directly via git.
210
186 - By default, git-svn passes --ignore-externals to svn to avoid
187 - fetching svn:external trees into git. Pass this flag to enable
188 - externals tracking directly via git.
211 +Versions of svn that do not support --ignore-externals are
212 +automatically detected and this flag will be automatically
213 +enabled for them.
214
190 - Versions of svn that do not support --ignore-externals are
191 - automatically detected and this flag will be automatically
192 - enabled for them.
215 +Otherwise, do not enable this flag unless you know what you're
216 +doing.
217
194 - Otherwise, do not enable this flag unless you know what you're
195 - doing.
218 +repo-config key: svn.noignoreexternals
219
197 - repo-config key: svn.noignoreexternals
220 +--
221
222 Basic Examples
223 ~~~~~~~~~~~~~~
@@ -226,6 +249,7 @@ any automated merge/branch tracking on the Subversion side and leaves it
249 entirely up to the user on the git side. It's simply not worth it to do
250 a useful translation when the original signal is weak.
251
252 +[[tracking-multiple-repos]]
253 TRACKING MULTIPLE REPOSITORIES OR BRANCHES
254 ------------------------------------------
255 This is for advanced users, most users should ignore this section.
@@ -241,6 +265,7 @@ invocation. The interface branch will be remotes/$GIT_SVN_ID, instead of
265 remotes/git-svn. Any remotes/$GIT_SVN_ID branch should never be modified
266 by the user outside of git-svn commands.
267
268 +[[fetch-args]]
269 ADDITIONAL FETCH ARGUMENTS
270 --------------------------
271 This is for advanced users, most users should ignore this section.
@@ -251,11 +276,15 @@ optionally be specified in the form of sha1 hex sums at the
276 command-line. Unfetched SVN revisions may also be tied to particular
277 git commits with the following syntax:
278
279 +------------------------------------------------
280 svn_revision_number=git_commit_sha1
281 +------------------------------------------------
282
256 -This allows you to tie unfetched SVN revision 375 to your current HEAD::
283 +This allows you to tie unfetched SVN revision 375 to your current HEAD:
284
258 - `git-svn fetch 375=$(git-rev-parse HEAD)`
285 +------------------------------------------------
286 + git-svn fetch 375=$(git-rev-parse HEAD)
287 +------------------------------------------------
288
289 Advanced Example: Tracking a Reorganized Repository
290 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~