Skip to content

Commit

Permalink
subtree: document new subtree commands
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Clarkson <tom@tqclarkson.com>
  • Loading branch information
tqc committed May 11, 2020
1 parent 27a43ea commit 19db9cf
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions contrib/subtree/git-subtree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ useful elsewhere, you can extract its entire history and publish
that as its own git repository, without accidentally
intermingling the history of your application project.

Although the relationship between subtree and mainline commits is stored
in regular git history, it is also cached between subtree runs. In most
cases this is merely a performance improvement, but for projects with
large and complex histories the cache can be manipulated directly
with the use, ignore and map commands.

[TIP]
In order to keep your commit messages clean, we recommend that
people split their commits between the subtrees and the main
Expand Down Expand Up @@ -120,6 +126,21 @@ and friends will work as expected.
Note that if you use '--squash' when you merge, you should usually not
just '--rejoin' when you split.

ignore::
Mark a commit and all of its history as irrelevant to subtree split.
In most cases this would be handled automatically based on metadata
from subtree join commits. Intended for improving performance on
extremely large repos and excluding complex history that turns out
to be otherwise problematic.

use::
Mark a commit and all of its history as part of an existing subtree.
In normal circumstances this would be handled based on the metadata
from the subtree join commit. Similar to the --onto option of split.

map::
Manually override the normal output of split for a particular commit.
Extreme flexibility for advanced troubleshooting purposes only.

OPTIONS
-------
Expand All @@ -142,6 +163,9 @@ OPTIONS
This option is only valid for add, merge and pull (unsure).
Specify <message> as the commit message for the merge commit.

--clear-cache::
Reset the subtree cache and recalculate all subtree mappings from the
commit history

OPTIONS FOR add, merge, push, pull
----------------------------------
Expand Down

0 comments on commit 19db9cf

Please sign in to comment.