From: "Tom Clarkson via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Avery Pennarun <apenwarr@gmail.com>,
Ed Maste <emaste@freebsd.org>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Tom Clarkson <tom@tqclarkson.com>,
Tom Clarkson <tom@tqclarkson.com>
Subject: [PATCH v2 7/7] subtree: document new subtree commands
Date: Tue, 06 Oct 2020 22:05:13 +0000 [thread overview]
Message-ID: <fe2e4819b869725f870cd3ce99f1f8150fe17dc1.1602021913.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.493.v2.git.1602021913.gitgitgadget@gmail.com>
From: Tom Clarkson <tom@tqclarkson.com>
Signed-off-by: Tom Clarkson <tom@tqclarkson.com>
---
contrib/subtree/git-subtree.txt | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/contrib/subtree/git-subtree.txt b/contrib/subtree/git-subtree.txt
index 352deda69d..a5a76e8ce6 100644
--- a/contrib/subtree/git-subtree.txt
+++ b/contrib/subtree/git-subtree.txt
@@ -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
@@ -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
-------
@@ -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
----------------------------------
--
gitgitgadget
next prev parent reply other threads:[~2020-10-06 22:05 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-11 5:49 [PATCH 0/7] subtree: Fix handling of complex history Tom Clarkson via GitGitGadget
2020-05-11 5:49 ` [PATCH 1/7] subtree: handle multiple parents passed to cache_miss Tom Clarkson via GitGitGadget
2020-05-11 5:49 ` [PATCH 2/7] subtree: exclude commits predating add from recursive processing Tom Clarkson via GitGitGadget
2020-05-11 5:49 ` [PATCH 3/7] subtree: persist cache between split runs Tom Clarkson via GitGitGadget
2020-05-11 5:49 ` [PATCH 4/7] subtree: add git subtree map command Tom Clarkson via GitGitGadget
2020-05-11 5:49 ` [PATCH 5/7] subtree: add git subtree use and ignore commands Tom Clarkson via GitGitGadget
2020-05-11 5:50 ` [PATCH 6/7] subtree: more robustly distinguish subtree and mainline commits Tom Clarkson via GitGitGadget
2020-05-11 5:50 ` [PATCH 7/7] subtree: document new subtree commands Tom Clarkson via GitGitGadget
2020-10-04 17:52 ` [PATCH 0/7] subtree: Fix handling of complex history Ed Maste
2020-10-04 19:27 ` Johannes Schindelin
2020-10-05 16:47 ` Junio C Hamano
2020-10-05 21:37 ` Ed Maste
2020-10-07 16:31 ` Johannes Schindelin
2020-10-06 22:05 ` [PATCH v2 " Tom Clarkson via GitGitGadget
2020-10-06 22:05 ` [PATCH v2 1/7] subtree: handle multiple parents passed to cache_miss Tom Clarkson via GitGitGadget
2020-10-07 13:12 ` Ed Maste
2020-10-06 22:05 ` [PATCH v2 2/7] subtree: exclude commits predating add from recursive processing Tom Clarkson via GitGitGadget
2020-10-07 15:36 ` Johannes Schindelin
2020-10-06 22:05 ` [PATCH v2 3/7] subtree: persist cache between split runs Tom Clarkson via GitGitGadget
2020-10-07 16:06 ` Johannes Schindelin
2020-10-06 22:05 ` [PATCH v2 4/7] subtree: add git subtree map command Tom Clarkson via GitGitGadget
2020-10-06 22:05 ` [PATCH v2 5/7] subtree: add git subtree use and ignore commands Tom Clarkson via GitGitGadget
2020-10-07 16:29 ` Johannes Schindelin
2020-10-06 22:05 ` [PATCH v2 6/7] subtree: more robustly distinguish subtree and mainline commits Tom Clarkson via GitGitGadget
2020-10-07 19:42 ` Johannes Schindelin
2020-10-06 22:05 ` Tom Clarkson via GitGitGadget [this message]
2020-10-07 19:43 ` [PATCH v2 7/7] subtree: document new subtree commands Johannes Schindelin
2020-10-07 19:46 ` [PATCH v2 0/7] subtree: Fix handling of complex history Johannes Schindelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=fe2e4819b869725f870cd3ce99f1f8150fe17dc1.1602021913.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=apenwarr@gmail.com \
--cc=emaste@freebsd.org \
--cc=git@vger.kernel.org \
--cc=tom@tqclarkson.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).