@matheusbsbs / matheus-bagliano / commits / 112f63851b
Fork 0

Documentation/git-svn.txt: Fix formatting errors

Fix some formatting problems: - Some list labels were missing their "::" characters. - Some of continuation paragraphs in labeled lists were incorrectly formatted as literal paragraphs. - In one case "[verse]" was missing before the config key list. - The "Basic Examples" section was incorrectly nested inside the "Config File-Only Options" section. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>

Sergey Vlasov committed Mar 1, 2007 at 22:41 UTC 112f63851bae2ff6f04092a2eb4261d6e5990c65
1 file changed +67 -52
Documentation/git-svn.txt
+67 -52
@@ -63,7 +63,7 @@ COMMANDS
63 transports (eg svn+ssh://), you must include the username in
64 the URL, eg svn+ssh://foo@svn.bar.com/project
65
66 ---prefix=<prefix>
66 +--prefix=<prefix>::
67 This allows one to specify a prefix which is prepended
68 to the names of remotes if trunk/branches/tags are
69 specified. The prefix does not automatically include a
@@ -94,16 +94,16 @@ COMMANDS
94 This fetches revisions from the SVN parent of the current HEAD
95 and rebases the current (uncommitted to SVN) work against it.
96
97 - This works similarly to 'svn update' or 'git-pull' except that
98 - it preserves linear history with 'git-rebase' instead of
99 - 'git-merge' for ease of dcommit-ing with git-svn.
97 +This works similarly to 'svn update' or 'git-pull' except that
98 +it preserves linear history with 'git-rebase' instead of
99 +'git-merge' for ease of dcommit-ing with git-svn.
100
101 - This accepts all options that 'git-svn fetch' and 'git-rebase'
102 - accepts. However '--fetch-all' only fetches from the current
103 - [svn-remote], and not all [svn-remote] definitions.
101 +This accepts all options that 'git-svn fetch' and 'git-rebase'
102 +accepts. However '--fetch-all' only fetches from the current
103 +[svn-remote], and not all [svn-remote] definitions.
104
105 - Like 'git-rebase'; this requires that the working tree be clean
106 - and have no uncommitted changes.
105 +Like 'git-rebase'; this requires that the working tree be clean
106 +and have no uncommitted changes.
107
108 'dcommit'::
109 Commit each diff from a specified head directly to the SVN
@@ -117,29 +117,40 @@ COMMANDS
117 alternative to HEAD.
118 This is advantageous over 'set-tree' (below) because it produces
119 cleaner, more linear history.
120 +--
121
122 'log'::
123 This should make it easy to look up svn log messages when svn
124 users refer to -r/--revision numbers.
125 ++
126 +The following features from `svn log' are supported:
127 ++
128 +--
129 +--revision=<n>[:<n>];;
130 + is supported, non-numeric args are not:
131 + HEAD, NEXT, BASE, PREV, etc ...
132 +-v/--verbose;;
133 + it's not completely compatible with the --verbose
134 + output in svn log, but reasonably close.
135 +--limit=<n>;;
136 + is NOT the same as --max-count, doesn't count
137 + merged/excluded commits
138 +--incremental;;
139 + supported
140 +--
141 ++
142 +New features:
143 ++
144 +--
145 +--show-commit;;
146 + shows the git commit sha1, as well
147 +--oneline;;
148 + our version of --pretty=oneline
149 +--
150 ++
151 +Any other arguments are passed directly to `git log'
152
125 - The following features from `svn log' are supported:
126 -
127 - --revision=<n>[:<n>] - is supported, non-numeric args are not:
128 - HEAD, NEXT, BASE, PREV, etc ...
129 - -v/--verbose - it's not completely compatible with
130 - the --verbose output in svn log, but
131 - reasonably close.
132 - --limit=<n> - is NOT the same as --max-count,
133 - doesn't count merged/excluded commits
134 - --incremental - supported
135 -
136 - New features:
137 -
138 - --show-commit - shows the git commit sha1, as well
139 - --oneline - our version of --pretty=oneline
140 -
141 - Any other arguments are passed directly to `git log'
142 -
153 +--
154 'set-tree'::
155 You should consider using 'dcommit' instead of this command.
156 Commit specified commit or tree objects to SVN. This relies on
@@ -256,16 +267,18 @@ config key: svn.authorsfile
267 Make git-svn less verbose.
268
269 --repack[=<n>]::
259 ---repack-flags=<flags>
260 - These should help keep disk usage sane for large fetches
261 - with many revisions.
270 +--repack-flags=<flags>::
271 +
272 +These should help keep disk usage sane for large fetches
273 +with many revisions.
274
263 - --repack takes an optional argument for the number of revisions
264 - to fetch before repacking. This defaults to repacking every
265 - 1000 commits fetched if no argument is specified.
275 +--repack takes an optional argument for the number of revisions
276 +to fetch before repacking. This defaults to repacking every
277 +1000 commits fetched if no argument is specified.
278
267 - --repack-flags are passed directly to gitlink:git-repack[1].
279 +--repack-flags are passed directly to gitlink:git-repack[1].
280
281 +[verse]
282 config key: svn.repack
283 config key: svn.repackflags
284
@@ -323,28 +336,30 @@ CONFIG FILE-ONLY OPTIONS
336
337 svn.noMetadata::
338 svn-remote.<name>.noMetadata::
326 - This gets rid of the git-svn-id: lines at the end of every commit.
339
328 - If you lose your .git/svn/git-svn/.rev_db file, git-svn will not
329 - be able to rebuild it and you won't be able to fetch again,
330 - either. This is fine for one-shot imports.
340 +This gets rid of the git-svn-id: lines at the end of every commit.
341 +
342 +If you lose your .git/svn/git-svn/.rev_db file, git-svn will not
343 +be able to rebuild it and you won't be able to fetch again,
344 +either. This is fine for one-shot imports.
345
332 - The 'git-svn log' command will not work on repositories using
333 - this, either. Using this conflicts with the 'useSvmProps'
334 - option for (hopefully) obvious reasons.
346 +The 'git-svn log' command will not work on repositories using
347 +this, either. Using this conflicts with the 'useSvmProps'
348 +option for (hopefully) obvious reasons.
349
350 svn.useSvmProps::
351 svn-remote.<name>.useSvmProps::
338 - This allows git-svn to re-map repository URLs and UUIDs from
339 - mirrors created using SVN::Mirror (or svk) for metadata.
352
341 - If an SVN revision has a property, "svm:headrev", it is likely
342 - that the revision was created by SVN::Mirror (also used by SVK).
343 - The property contains a repository UUID and a revision. We want
344 - to make it look like we are mirroring the original URL, so
345 - introduce a helper function that returns the original identity
346 - URL and UUID, and use it when generating metadata in commit
347 - messages.
353 +This allows git-svn to re-map repository URLs and UUIDs from
354 +mirrors created using SVN::Mirror (or svk) for metadata.
355 +
356 +If an SVN revision has a property, "svm:headrev", it is likely
357 +that the revision was created by SVN::Mirror (also used by SVK).
358 +The property contains a repository UUID and a revision. We want
359 +to make it look like we are mirroring the original URL, so
360 +introduce a helper function that returns the original identity
361 +URL and UUID, and use it when generating metadata in commit
362 +messages.
363
364 svn.useSvnsyncProps::
365 svn-remote.<name>.useSvnsyncprops::
@@ -369,8 +384,8 @@ section because they affect the 'git-svn-id:' metadata line.
384
385 --
386
372 -Basic Examples
373 -~~~~~~~~~~~~~~
387 +BASIC EXAMPLES
388 +--------------
389
390 Tracking and contributing to a the trunk of a Subversion-managed project:
391