undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

subtree: fix AsciiDoc list item continuation

Browse Source 
List items must be continued with '+' (see [asciidoc]).

[asciidoc] AsciiDoc user guide 17.7. List Item Continuation
    <http://www.methods.co.nz/asciidoc/userguide.html#X15>

Signed-off-by: Steffen Prohaska <prohaska@zib.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Steffen Prohaska 2015-01-04 11:54:47 +01:00 committed by Junio C Hamano
parent c2e8e4b9da
commit e0a1f09313
1 changed files with 89 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
contrib/subtree/git-subtree.txt
View File

@ -81,12 +81,11 @@ merge::
changes into the latest <commit>. With '--squash', changes into the latest <commit>. With '--squash',
creates only one commit that contains all the changes, creates only one commit that contains all the changes,
rather than merging in the entire history. rather than merging in the entire history.
+
If you use '--squash', the merge direction doesn't If you use '--squash', the merge direction doesn't always have to be
always have to be forward; you can use this command to forward; you can use this command to go back in time from v2.5 to v2.4,
go back in time from v2.5 to v2.4, for example. If your for example. If your merge introduces a conflict, you can resolve it in
merge introduces a conflict, you can resolve it in the the usual ways.
usual ways.
pull:: pull::
Exactly like 'merge', but parallels 'git pull' in that Exactly like 'merge', but parallels 'git pull' in that
@ -107,21 +106,19 @@ split::
contents of <prefix> at the root of the project instead contents of <prefix> at the root of the project instead
of in a subdirectory. Thus, the newly created history of in a subdirectory. Thus, the newly created history
is suitable for export as a separate git repository. is suitable for export as a separate git repository.
+
After splitting successfully, a single commit id is After splitting successfully, a single commit id is printed to stdout.
printed to stdout. This corresponds to the HEAD of the This corresponds to the HEAD of the newly created tree, which you can
newly created tree, which you can manipulate however you manipulate however you want.
want. +
Repeated splits of exactly the same history are guaranteed to be
Repeated splits of exactly the same history are identical (i.e. to produce the same commit ids). Because of this, if
guaranteed to be identical (i.e. to produce the same you add new commits and then re-split, the new commits will be attached
commit ids). Because of this, if you add new commits as commits on top of the history you generated last time, so 'git merge'
and then re-split, the new commits will be attached as and friends will work as expected.
commits on top of the history you generated last time, +
so 'git merge' and friends will work as expected. Note that if you use '--squash' when you merge, you should usually not
just '--rejoin' when you split.
Note that if you use '--squash' when you merge, you
should usually not just '--rejoin' when you split.
OPTIONS OPTIONS
@ -151,109 +148,96 @@ OPTIONS FOR add, merge, push, pull
--squash:: --squash::
This option is only valid for add, merge, push and pull This option is only valid for add, merge, push and pull
commands. commands.
+
Instead of merging the entire history from the subtree Instead of merging the entire history from the subtree project, produce
project, produce only a single commit that contains all only a single commit that contains all the differences you want to
the differences you want to merge, and then merge that merge, and then merge that new commit into your project.
new commit into your project. +
Using this option helps to reduce log clutter. People rarely want to see
Using this option helps to reduce log clutter. People every change that happened between v1.0 and v1.1 of the library they're
rarely want to see every change that happened between using, since none of the interim versions were ever included in their
v1.0 and v1.1 of the library they're using, since none of the application.
interim versions were ever included in their application. +
Using '--squash' also helps avoid problems when the same subproject is
Using '--squash' also helps avoid problems when the same included multiple times in the same project, or is removed and then
subproject is included multiple times in the same re-added. In such a case, it doesn't make sense to combine the
project, or is removed and then re-added. In such a histories anyway, since it's unclear which part of the history belongs
case, it doesn't make sense to combine the histories to which subtree.
anyway, since it's unclear which part of the history +
belongs to which subtree. Furthermore, with '--squash', you can switch back and forth between
different versions of a subtree, rather than strictly forward. 'git
Furthermore, with '--squash', you can switch back and subtree merge --squash' always adjusts the subtree to match the exactly
forth between different versions of a subtree, rather specified commit, even if getting to that commit would require undoing
than strictly forward. 'git subtree merge --squash' some changes that were added earlier.
always adjusts the subtree to match the exactly +
specified commit, even if getting to that commit would Whether or not you use '--squash', changes made in your local repository
require undoing some changes that were added earlier. remain intact and can be later split and send upstream to the
subproject.
Whether or not you use '--squash', changes made in your
local repository remain intact and can be later split
and send upstream to the subproject.
OPTIONS FOR split OPTIONS FOR split
----------------- -----------------
--annotate=<annotation>:: --annotate=<annotation>::
This option is only valid for the split command. This option is only valid for the split command.
+
When generating synthetic history, add <annotation> as a When generating synthetic history, add <annotation> as a prefix to each
prefix to each commit message. Since we're creating new commit message. Since we're creating new commits with the same commit
commits with the same commit message, but possibly message, but possibly different content, from the original commits, this
different content, from the original commits, this can help can help to differentiate them and avoid confusion.
to differentiate them and avoid confusion. +
Whenever you split, you need to use the same <annotation>, or else you
Whenever you split, you need to use the same don't have a guarantee that the new re-created history will be identical
<annotation>, or else you don't have a guarantee that to the old one. That will prevent merging from working correctly. git
the new re-created history will be identical to the old subtree tries to make it work anyway, particularly if you use --rejoin,
one. That will prevent merging from working correctly. but it may not always be effective.
git subtree tries to make it work anyway, particularly
if you use --rejoin, but it may not always be effective.
-b <branch>:: -b <branch>::
--branch=<branch>:: --branch=<branch>::
This option is only valid for the split command. This option is only valid for the split command.
+
After generating the synthetic history, create a new After generating the synthetic history, create a new branch called
branch called <branch> that contains the new history. <branch> that contains the new history. This is suitable for immediate
This is suitable for immediate pushing upstream. pushing upstream. <branch> must not already exist.
<branch> must not already exist.
--ignore-joins:: --ignore-joins::
This option is only valid for the split command. This option is only valid for the split command.
+
If you use '--rejoin', git subtree attempts to optimize If you use '--rejoin', git subtree attempts to optimize its history
its history reconstruction to generate only the new reconstruction to generate only the new commits since the last
commits since the last '--rejoin'. '--ignore-join' '--rejoin'. '--ignore-join' disables this behaviour, forcing it to
disables this behaviour, forcing it to regenerate the regenerate the entire history. In a large project, this can take a long
entire history. In a large project, this can take a time.
long time.
--onto=<onto>:: --onto=<onto>::
This option is only valid for the split command. This option is only valid for the split command.
+
If your subtree was originally imported using something If your subtree was originally imported using something other than git
other than git subtree, its history may not match what subtree, its history may not match what git subtree is expecting. In
git subtree is expecting. In that case, you can specify that case, you can specify the commit id <onto> that corresponds to the
the commit id <onto> that corresponds to the first first revision of the subproject's history that was imported into your
revision of the subproject's history that was imported project, and git subtree will attempt to build its history from there.
into your project, and git subtree will attempt to build +
its history from there. If you used 'git subtree add', you should never need this option.
If you used 'git subtree add', you should never need
this option.
--rejoin:: --rejoin::
This option is only valid for the split command. This option is only valid for the split command.
+
After splitting, merge the newly created synthetic After splitting, merge the newly created synthetic history back into
history back into your main project. That way, future your main project. That way, future splits can search only the part of
splits can search only the part of history that has history that has been added since the most recent --rejoin.
been added since the most recent --rejoin. +
If your split commits end up merged into the upstream subproject, and
If your split commits end up merged into the upstream then you want to get the latest upstream version, this will allow git's
subproject, and then you want to get the latest upstream merge algorithm to more intelligently avoid conflicts (since it knows
version, this will allow git's merge algorithm to more these synthetic commits are already part of the upstream repository).
intelligently avoid conflicts (since it knows these +
synthetic commits are already part of the upstream Unfortunately, using this option results in 'git log' showing an extra
repository). copy of every new commit that was created (the original, and the
synthetic one).
Unfortunately, using this option results in 'git log' +
showing an extra copy of every new commit that was If you do all your merges with '--squash', don't use '--rejoin' when you
created (the original, and the synthetic one). split, because you don't want the subproject's history to be part of
your project anyway.
If you do all your merges with '--squash', don't use
'--rejoin' when you split, because you don't want the
subproject's history to be part of your project anyway.
EXAMPLE 1. Add command EXAMPLE 1. Add command