1 =========================================
2 TopGit -- A different patch queue manager
3 =========================================
9 TopGit aims to make handling of large amounts of interdependent topic
10 branches easier. In fact, it is designed especially for the case where
11 you maintain a queue of third-party patches on top of another (perhaps
12 Git-controlled) project and want to easily organize, maintain and submit
13 them -- TopGit achieves that by keeping a separate topic branch for each
14 patch and providing some tools to maintain the branches.
18 :REQUIREMENTS_: Installation requirements
19 :SYNOPSIS_: Command line example session
20 :USAGE_: Command line details
21 :`NO UNDO`_: Where's the undo!!!
22 :CONVENTIONS_: Suggestions for organizing your TopGit branches
23 :`EXTRA SETTINGS`_: Various possible "topgit.*" config settings
24 :ALIASES_: Git-like TopGit command aliases
25 :NAVIGATION_: Getting around with "next" and "prev"
26 :GLOSSARY_: All the TopGit vocabulary in one place
27 :TECHNICAL_: How it works behind the scenes
33 TopGit is a collection of POSIX shell scripts so a POSIX-compliant shell is
34 required along with some standard POSIX-compliant utilities (e.g. sed, awk,
35 cat, etc.). Git version 1.8.5 or later is also required.
37 To use TopGit with linked working trees (the ``git worktree add`` command),
38 at least Git version 2.5.0 (obviously, since that's when the ``git worktree``
39 command first appeared) is needed in which case linked working trees are then
40 fully supported for use with TopGit.
42 The scripts need to be preprocessed and installed. The Makefile that does
43 this only requires a POSIX make utility. However, running the tests (using
44 "`make test`") still does require GNU make at this point, but the tests do
45 not need to be run in order to install (using "`make install`").
47 It is possible to use the DESTDIR functionality to install TopGit to a
48 staging area on one machine, archive that and then unarchive it on another
49 machine to perform an install (provided the build prefix and other options are
50 compatible with the final installed location).
56 See the file ``INSTALL``.
62 The TopGit git repository can be found at <http://repo.or.cz/topgit/pro>.
68 Why not use something like StGIT or Guilt or ``rebase -i`` for maintaining
69 your patch queue? The advantage of these tools is their simplicity;
70 they work with patch *series* and defer to the reflog facility for
71 version control of patches (reordering of patches is not
72 version-controlled at all). But there are several disadvantages -- for
73 one, these tools (especially StGIT) do not actually fit well with plain
74 Git at all: it is basically impossible to take advantage of the index
75 effectively when using StGIT. But more importantly, these tools
76 horribly fail in the face of a distributed environment.
78 TopGit has been designed around three main tenets:
80 (i) TopGit is as thin a layer on top of Git as possible. You
81 still maintain your index and commit using Git; TopGit will only
82 automate a few indispensable tasks.
84 (ii) TopGit is anxious about *keeping* your history. It will
85 never rewrite your history, and all metadata is also tracked
86 by Git, smoothly and non-obnoxiously. It is good to have a
87 *single* point when the history is cleaned up, and that is at
88 the point of inclusion in the upstream project; locally, you
89 can see how your patch has evolved and easily return to older
92 (iii) TopGit is specifically designed to work in a
93 distributed environment. You can have several instances of
94 TopGit-aware repositories and smoothly keep them all
95 up-to-date and transfer your changes between them.
97 As mentioned above, the main intended use-case for TopGit is tracking
98 third-party patches, where each patch is effectively a single topic
99 branch. In order to flexibly accommodate even complex scenarios when
100 you track many patches where many are independent but some depend on
101 others, TopGit ignores the ancient Quilt heritage of patch series and
102 instead allows the patches to freely form graphs (DAGs just like Git
103 history itself, only "one level higher"). For now, you have to manually
104 specify which patches the current one depends on, but TopGit might help
105 you with that in the future in a darcs-like fashion.
107 A glossary_ plug: The union (i.e. merge) of patch dependencies is called
108 a *base* of the patch (topic branch).
110 Of course, TopGit is perhaps not the right tool for you:
112 (i) TopGit is not complicated, but StGIT et al. are somewhat
113 simpler, conceptually. If you just want to make a linear
114 purely-local patch queue, deferring to StGIT instead might
117 (ii) When using TopGit, your history can get a little hairy
118 over time, especially with all the merges rippling through.
127 ## Create and evolve a topic branch
128 $ tg create t/gitweb/pathinfo-action
129 tg: Automatically marking dependency on master
130 tg: Creating t/gitweb/pathinfo-action base from master...
136 ## Create another topic branch on top of the former one
137 $ tg create t/gitweb/nifty-links
138 tg: Automatically marking dependency on t/gitweb/pathinfo-action
139 tg: Creating t/gitweb/nifty-links base from t/gitweb/pathinfo-action...
143 ## Create another topic branch on top of master and submit
144 ## the resulting patch upstream
145 $ tg create t/revlist/author-fixed master
146 tg: Creating t/revlist/author-fixed base from master...
150 tg: Sent t/revlist/author-fixed
152 To: git@vger.kernel.org
153 Cc: gitster@pobox.com
154 Subject: [PATCH] Fix broken revlist --author when --fixed-string
156 ## Create another topic branch depending on two others non-trivially
157 $ tg create t/whatever t/revlist/author-fixed t/gitweb/nifty-links
158 tg: Creating t/whatever base from t/revlist/author-fixed...
159 tg: Merging t/whatever base with t/gitweb/nifty-links...
161 tg: Please commit merge resolution and call: tg update --continue
162 tg: It is also safe to abort this operation using `git reset --hard`
163 tg: but please remember you are on the base branch now;
164 tg: you will want to switch to a different branch.
167 $ tg update --continue
171 ## Update a single topic branch and propagate the changes to
173 $ git checkout t/gitweb/nifty-links
176 $ git checkout t/whatever
178 Topic Branch: t/whatever (1 commit)
179 Subject: [PATCH] Whatever patch
181 Depends: t/revlist/author-fixed t/gitweb/nifty-links
183 t/gitweb/nifty-links (1 commit)
185 tg: Updating base with t/gitweb/nifty-links changes...
187 tg: Please commit merge resolution and call `tg update --continue`
188 tg: (use `tg status` to see more options)
191 $ tg update --continue
192 tg: Updating t/whatever against new base...
194 tg: Please commit merge resolution and call `tg update --continue`
195 tg: (use `tg status` to see more options)
198 $ tg update --continue
200 ## Update a single topic branch and propagate the changes
201 ## further through the dependency chain
202 $ git checkout t/gitweb/pathinfo-action
205 $ git checkout t/whatever
207 Topic Branch: t/whatever (1/2 commits)
208 Subject: [PATCH] Whatever patch
210 Depends: t/revlist/author-fixed t/gitweb/nifty-links
212 t/gitweb/pathinfo-action (<= t/gitweb/nifty-links) (1 commit)
214 tg: Recursing to t/gitweb/nifty-links...
215 [t/gitweb/nifty-links] tg: Updating base with t/gitweb/pathinfo-action changes...
217 [t/gitweb/nifty-links] tg: Please commit merge resolution and call `tg update --continue`
218 [t/gitweb/nifty-links] tg: (use `tg status` to see more options)
221 $ tg update --continue
222 [t/gitweb/nifty-links] tg: Updating t/gitweb/nifty-links against new base...
224 [t/gitweb/nifty-links] tg: Please commit merge resolution and call `tg update --continue`
225 [t/gitweb/nifty-links] tg: (use `tg status` to see more options)
228 $ tg update --continue
229 tg: Updating base with t/gitweb/nifty-links changes...
230 tg: Updating t/whatever against new base...
232 ## Clone a TopGit-controlled repository
235 $ tg remote --populate origin
240 ## Add a TopGit remote to a repository and push to it
241 $ git remote add foo URL
245 ## Update from a non-default TopGit remote
254 When using TopGit there are several common conventions used when working with
255 TopGit branches. None of them are enforced, they are only suggestions.
257 There are three typical uses for a TopGit branch:
260 Normal TopGit branches that represent a single patch. These are known
261 as "patch" TopGit branches.
263 Empty TopGit branches with no dependencies (an empty ``.topdeps`` file)
264 that represent a base upon which other "normal" TopGit branches depend.
265 These are known as "base" TopGit branches (not to be confused with
266 the refs/top-bases/... refs).
268 Empty TopGit branches that serve as a staging area to bring together
269 several other TopGit branches into one place so they can be used/tested
270 all together. These are known as "stage" TopGit branches.
272 An "empty" TopGit branch is one that does not have any changes of its own --
273 it may still have dependencies though ("stage" branches do, "base" branches do
274 not). The ``tg summary`` output shows empty branches with a ``0`` in the
275 listing. Normal "patch" branches that have not been annihilated, "base" and
276 "stage" branches fall into this category. (Annihilated branches are normally
277 omitted from the ``tg summary`` output but can be shown if given explicitly as
278 an argument to the ``tg summary`` command. However, the message line will be
279 incorrect since an annihilated branch has no ``.topmsg`` file of its own.)
281 A "patch" branch name typically starts with ``t/`` whereas "base" and "stage"
282 branch names often do not.
284 A "base" branch is created by using the ``--base`` option of ``tg create``
285 (aka ``--no-deps``) which will automatically suggest a "[BASE]" message prefix
286 rather than "[PATCH]". A "stage" branch is created like a normal patch branch
287 except that the only changes that will ever be made to it are typically to
288 add/remove dependencies. Its subject prefix must be manually changed to
289 "[STAGE]" to reflect its purpose.
291 Since both "base" and "stage" branches typically only have a use for the
292 "Subject:" line from their ``.topmsg`` file, they are quite easily created
293 using the ``--topmsg`` option of ``tg create``.
295 Use of "stage" and "base" branches is completely optional. However, without
296 use of a "stage" branch it will be difficult to test multiple independent
297 patches together all at once. A "base" branch is merely a convenience that
298 provides more explicit control over when a common base for a set of patches
299 gets updated as well as providing a branch that shows in ``tg summary`` output
300 and participates in ``tg remote --populate`` setup.
302 Another advantage to using a "stage" branch is that if a new "patch" branch
303 is created remotely and that new branch is added to a pre-existing "stage"
304 branch on the remote then when the local version of the "stage" branch is
305 updated (after fetching remote updates of course), that new dependency will
306 be merged into the local "stage" branch and the local version of the new remote
307 "patch" branch will be automatically set up at "tg update" time.
309 When using the ``tg tag`` command to create tags that record the current state
310 of one or more TopGit branches, the tags are often created with a name that
313 One last thing, you have enabled ``git rerere`` haven't you?
319 Beware, there is no "undo" after running a ``tg update``!
321 Well, that's not entirely correct. Since ``tg update`` never discards commits
322 an "undo" operation is technically feasible provided the old values of all the
323 refs that were affected by the ``tg update`` operation can be determined and
324 then they are simply changed back to their previous values.
326 In practice though, it can be extremely tedious and error prone looking through
327 log information to try and determine what the correct previous values were.
328 Although, since TopGit tries to make sure reflogs are enabled for top-bases
329 refs, using Git's ``@{date}`` notation on all the refs dumped out by a
330 ``tg tag --refs foo``, where "foo" is the branch that was updated whose update
331 needs to be undone, may work.
333 Alternatively, ``tg tag --stash`` can be used prior to the update and then
334 ``tg revert`` used after the update to restore the previous state. This
335 assumes, of course, that you remember to run ``tg tag --stash`` first.
337 The ``tg update`` command understands a ``--stash`` option that tells it to
338 automatically run ``tg tag --stash`` before it starts making changes (if
339 everything is up-to-date it won't run the stash command at all).
341 The ``--stash`` option is the default nowadays when running ``tg update``,
342 add the ``--no-stash`` option to turn it off.
344 There is a preference for this. Setting the config value ``topgit.autostash``
345 to ``false`` will implicitly add the ``--no-stash`` option to any ``tg update``
346 command unless an explicit ``--stash`` option is given.
348 If you are likely to ever want to undo a ``tg update``, setting
349 ``topgit.autostash`` to ``false`` is highly discouraged!
351 Note that the tags saved by ``tg tag --stash`` are stored in the
352 ``refs/tgstash`` ref and its reflog. Unfortunately, while Git is happy to
353 maintain the reflog (once it's been enabled which ``tg tag`` guarantees for
354 ``refs/tgstash``), Git is unable to view an annotated/signed tag's reflog!
355 Instead Git dereferences the tag and shows the wrong thing. Use the
356 ``tg tag -g`` command to view the ``refs/tgstash`` reflog instead.
362 TopGit supports various config settings:
364 :ALIASES_: ``topgit.alias.*`` for Git-like command aliases
365 :`tg update`_: ``topgit.autostash`` automatic stash control
366 :`tg patch`_: ``topgit.from`` "From:" fixups by ``tg patch``
367 :`REMOTE HANDLING`_: ``topgit.remote`` TopGit's default remote
368 :SEQUESTRATION_: ``topgit.sequester`` for sequestration control
369 :`tg update`_: ``topgit.setAutoUpdate`` => ``rerere.autoUpdate``
370 :`tg migrate-bases`_: ``topgit.top-bases`` for refs bases location
376 These work exactly like Git's aliases except they are stored under
377 ``topgit.alias.*`` instead. See the ``git help config`` output under
378 the ``alias.*`` section for details. Do note that while alias nesting is
379 explicitly permitted, a maximum nesting depth of 10 is enforced to help
380 detect accidental aliasing loops from wedging the machine.
382 For example, to create an ``lc`` alias for the ``tg log --compact`` command
383 this command may be used:
387 git config --global topgit.alias.lc "log --compact"
389 To make it specific to a particular repository just omit the ``--global``
390 option from the command.
395 From Previous to Next
396 ~~~~~~~~~~~~~~~~~~~~~
398 For this section, consider the following patch series, to be applied
399 in numerical order as shown:
403 0001-F_first-patch.diff
404 0002-G_second-builds-on-F.diff
405 0003-H_third-builds-on-G.diff
406 0004-I_fourth-builds-on-H.diff
407 0005-J_fifth-builds-on-I.diff
408 0006-K_sixth-builds-on-J.diff
409 0007-L_last-patch-needs-K.diff
411 If these were applied to some commit in a Git repository, say commit "A"
412 then a history that looks like this would be created:
416 A---F---G---H---I---J---K---L
418 Where the parent of commit "F" is "A" and so on to where the parent of
419 commit "L" is commit "K".
421 If that commit history, from A through L, was then imported into TopGit, one
422 TopGit branch would be created corresponding to each of the commits F
423 through L. This way, for example, if the fourth patch in the series
424 (``0004-I_...diff``) needs work, the TopGit branch corresponding to its patch
425 can be checked out and changes made and then a new version of its patch
426 created (using ``tg patch``) without disturbing the other patches in the series
427 and when ``tg update`` is run, the patches that "follow" the fourth patch
428 (i.e. 5, 6 and 7) will have their corresponding TopGit branches automatically
429 updated to take into account the changes made to the fourth patch.
431 Okay, enough with the review of TopGit systemology
432 ``````````````````````````````````````````````````
434 Imagine then that you are working on the fourth patch (i.e. you have its
435 branch checked out into the working tree) and you want to move to the following
436 patch in the series because you have a nit to pick with it too.
438 If you can't remember the exact name you might have to fumble around or, you
439 can display the name of the following or "next" patch's branch with the, you
440 guessed it, ``tg next`` command. Think of "next" as the "next" logical patch
441 in the series or the next following patch. If the patches are numbered as in
442 the list above, "next" corresponds to the "+1" (plus one) patch.
444 You might have already guessed there's a corresponding ``tg prev`` command
445 which displays the "-1" (minus one) patch. If these commands (``tg next``
446 and ``tg prev``) are not given a branch name to start at they start at the
447 patch corresponding to the current ``HEAD``.
449 Displaying, however, is not so helpful as actually going there. That's where
450 the ``tg checkout`` command comes in. ``tg checkout next`` does a
451 ``git checkout`` of the ``tg next`` branch and, not surprisingly,
452 ``tg checkout prev`` does a ``git checkout`` of the ``tg prev`` branch. For
453 the lazy a single ``n`` or ``p`` can be used with ``tg checkout`` instead of
454 typing out the entire ``next`` or ``prev``. Or, for the anal, ``previous``
455 will also be accepted for ``prev``.
457 Referring to the A...L commit graph shown above, I is the parent of J and,
458 conversely, J is the child of I. (Git only explicitly records the child to
459 parent links, in other words a "child" points to zero or more "parents", but
460 parents are completely clueless about their own children.)
462 For historical reasons, the ``tg checkout`` command accepts ``child`` as a
463 synonym for ``next`` and ``parent`` as a synonym for ``prev``. However, this
464 terminology can be confusing since Git has "parent" links but ``tg checkout``
465 is referring to the TopGit DAG, not Git's. Best to just avoid using ``child``
466 or ``parent`` to talk about navigating the TopGit DAG and reserve them
467 strictly for discussing the Git DAG.
469 There may be more than one
470 ``````````````````````````
472 In a simple linear history as shown above there's always only one "next" or
473 "prev" patch. However, TopGit does not restrict one to only a linear
474 history (although that can make patch exports just a bushel of fun).
476 Suffice it to say that there is always a single linearized ordering for any
477 TopGit patch series since it's always a DAG (Directed Acyclic Graph), but it
478 may not be immediately obvious to the casual observer what that is.
480 The ``tg checkout`` command will display a list to choose from if ``next``
481 or ``prev`` would be ambiguous.
483 Use the ``tg info/checkout --series`` command
484 `````````````````````````````````````````````
486 To see the full, linearized, list of patches with their summary displayed in
487 order from first to last patch in the series, just run the ``tg info --series``
488 command. It takes the name of any patch in the series automatically using
489 ``HEAD`` if none is given. It even provides a nice "YOU ARE HERE" mark in
490 the output list helpful to those who have been absent for a time engaging in
491 otherwise distracting activities and need to be reminded where they are.
493 Using ``tg checkout --series`` can take you there (picking from a list) if
494 you've forgotten the way back to wherever you're supposed to be.
496 Don't get pushy, there's just one more thing
497 ````````````````````````````````````````````
499 For historical reasons, ``tg checkout`` with no arguments whatsoever behaves
500 like ``tg checkout next``. For the same historical reasons, ``tg checkout ..``
501 behaves like ``tg checkout prev`` (think of ``..`` as the "parent" directory
502 and since "parent" means "prev" in this context it will then make sense).
504 Now, for that one more thing. Consider that you have a pristine "upstream"
505 tarball, repository, source dump or otherwise obtained set of unmodified
506 source files that need to be patched. View them like so:
510 +-------------------------------+
511 | Unmodified "upstream" source |
512 | files represented with "A" |
513 +-------------------------------+
515 Now, add the first patch, 0001, to them and view the result like so:
519 +--------------------------+----+
520 | Patch 0001 represented by "F" |
521 +-------------------------------+
522 | Unmodified "upstream" source |
523 | files represented with "A" |
524 +-------------------------------+
526 Not stopping there, "push" patches 2, 3 and 4 onto the stack as well like so:
530 +--------------------------+----+
531 | Patch 0004 represented by "I" |
532 +--------------------------+----+
533 | Patch 0003 represented by "H" |
534 +--------------------------+----+
535 | Patch 0002 represented by "G" |
536 +--------------------------+----+
537 | Patch 0001 represented by "F" |
538 +-------------------------------+
539 | Unmodified "upstream" source |
540 | files represented with "A" |
541 +-------------------------------+
543 In other words, to go to the "next" patch in the series it needs to be "push"ed
544 onto the stack. ``tg checkout`` accepts ``push`` as an alias for ``next``.
546 Similarly to go to the "previous" patch in the series the current one needs
547 to be "pop"ped off the stack. ``tg checkout`` accepts ``pop`` as an alias
550 Unfortunately for these aliases, in Git terminology a "push" has quite a
551 different meaning and the ``tg push`` command does something quite different
552 from ``tg checkout push``. Then there's the matter of using a single letter
553 abbreviation for the lazy -- ``p`` would mean what exactly?
555 ``tg checkout`` continues to accept the ``push`` and ``pop`` aliases for
556 ``next`` and ``prev`` respectively, but it's best to avoid them since
557 ``push`` has an alternate meaning everywhere else in TopGit and Git and that
558 leaves ``pop`` all alone in the dark.
564 No, this is not a section about budget nonsense. ;)
566 TopGit keeps its metadata in ``.topdeps`` and ``.topmsg`` files. In an effort
567 to facilitate cherry-picking and other Git activities on the patch changes
568 themselves while ignoring the TopGit metadata, TopGit attempts to keep all
569 changes to ``.topdeps`` and ``.topmsg`` files limited to commits that do NOT
570 contain changes to any other files.
572 This is a departure from previous TopGit versions that made no such effort.
574 Primarily this affects ``tg create`` and ``tg import`` (which makes use of
575 ``tg create``) as ``tg create`` will commit the initial versions of
576 ``.topdeps`` and ``.topmsg`` for a new TopGit-controlled branch in their own
577 commit instead of mixing them in with changes to other files.
579 The ``pre-commit`` hook will also attempt to separate out any ``.topdeps`` and
580 ``.topmsg`` changes from commits that include changes to other files.
582 It is possible to defeat these checks without much effort (``pre-commit`` hooks
583 can easily be bypassed, ``tg create`` has a ``--no-commit`` option, many Git
584 commands simply do not run the ``pre-commit`` hook, etc.).
586 If you really, really, really, really want to change the default back to the
587 old behavior of previous TopGit versions where no such sequestration took
588 place, then set the ``topgit.sequester`` config variable explicitly to the
589 value ``false``. But this is not recommended.
592 AMENDING AND REBASING AND UPDATE-REF'ING
593 ----------------------------------------
597 It is okay to manually update a top-bases/... ref when a) it has no depedencies
598 (i.e. it was created with the ``tg create`` ``--base`` option) and b) the
599 old top-bases/... ref value can be fast-forwarded to the new top-bases/...
600 value OR the new value contains ALL of the changes in the old value through
601 some other mechanism (perhaps they were cherry-picked or otherwise applied to
602 the new top-bases/... ref). The same rules apply to non-TopGit-controlled
603 dependencies. Use the ``tg update --base <branch> <new-ref>`` command to
604 safely make such an update while making it easy to set the merge commit
605 message at the same time.
607 Ignoring this rule and proceeding anyway with a non-fast-forward update to a
608 top-bases/... ref will result in changes present in the new value being merged
609 into the branch (at ``tg update`` time) as expected (possibly with conflicts),
610 but any changes that were contained in the old version of the top-bases/... ref
611 which have been dropped (i.e. are NOT contained in the new version of the
612 top-bases/... ref) will continue to be present in the branch! To get rid of
613 the dropped commits, one or more "revert" commits will have to be manually
614 applied to the tip of the new top-bases/... value (which will then be merged
615 into the branch at next ``tg update`` time).
617 The only time it's safe to amend, rebase, filter or otherwise rewrite commits
618 contained in a TopGit controlled branch or non-TopGit branch is when those
619 commits are NOT reachable via any other ref!
621 Furthermore, while it is safe to rewrite merge commits (provided they meet the
622 same conditions) the merge commits themselves and the branches they are merging
623 in must be preserved during the rewrite and that can be rather tricky to get
624 right so it's not recommended.
626 For example, if, while working on a TopGit-controlled branch ``foo``, a bad
627 typo is noticed, it's okay to ammend/rebase to fix that provided neither
628 ``tg update`` nor ``tg create`` has already been used to cause some other ref
629 to be able to reach the commit with the typo.
631 If an amend or rerwite is done anyway even though the commit with the typo is
632 reachable from some other ref, the typo won't really be removed. What will
633 happen instead is that the new version without the typo will ultimately be
634 merged into the other ref(s) (at ``tg update`` time) likely causing a conflict
635 that will have to be manually resolved and the commit with the typo will
636 continue to be reachable from those other refs!
638 Instead just make a new commit to fix the typo. The end result will end up
639 being the same but without the merge conflicts.
641 See also the discussion in the `NO UNDO`_ section.
647 TopGit needs to check many things to determine whether a TopGit branch is
648 up-to-date or not. This can involve a LOT of git commands for a complex
649 dependency tree. In order to speed things up, TopGit keeps a cache of results
650 in a ``tg-cache`` subdirectory in the ``.git`` directory.
652 Results are tagged with the original hash values used to get that result so
653 that items which have not been changed return their results quickly and items
654 which have been changed compute their new result and cache it for future use.
656 The ``.git/tg-cache`` directory may be removed at any time and the cache will
657 simply be recreated in an on-demand fashion as needed, at some speed penalty,
658 until it's fully rebuilt.
660 To force the cache to be fully pre-loaded, run the ``tg summary`` command
661 without any arguments. Otherwise, normal day-to-day TopGit operations should
662 keep it more-or-less up-to-date.
664 While each TopGit command is running, it uses a temporary subdirectory also
665 located in the ``.git`` directory. These directories are named
666 ``tg-tmp.XXXXXX`` where the ``XXXXXX`` part will be random letters and digits.
668 These temporary directories should always be removed automatically after each
669 TopGit command finishes running. As long as you are not in a subshell as a
670 result of a TopGit command stopping and waiting for a manual merge resolution,
671 it's safe to remove any of these directories that may have somehow accidentally
672 been left behind as a result of some failure that occurred while running a
673 TopGit command (provided, of course, it's not actually being used by a TopGit
674 command currently running in another terminal window or by another user on the
680 ``tg [global options] <subcommand> [<subcommand option/argument>...]``
684 ``[-C <dir>]... [-r <remote> | -u] [-c <name>=<val>]... [--no-pager]``
686 -C <dir> Change directory to <dir> before doing anything more
687 -r <remote> Pretend ``topgit.remote`` is set to <remote>
688 -u Pretend ``topgit.remote`` is not set
689 -c <name=val> Pass config option to git, may be repeated
690 --no-pager Disable use of any pager (by both TopGit and Git)
691 --top-bases Show full ``top-bases`` ref prefix and exit
692 --exec-path Show path to subcommand scripts location and exit
693 --help Show brief usage help and exit (aka ``-h``)
695 The ``tg`` tool has several subcommands:
697 :`tg annihilate`_: Mark a TopGit-controlled branch as defunct
698 :`tg base`_: Show base commit for one or more TopGit branches
699 :`tg checkout`_: Shortcut for git checkout with name matching
700 :`tg contains`_: Which TopGit-controlled branch contains the commit
701 :`tg create`_: Create a new TopGit-controlled branch
702 :`tg delete`_: Delete a TopGit-controlled branch cleanly
703 :`tg depend`_: Add a new dependency to a TopGit-controlled branch
704 :`tg export`_: Export TopGit branch patches to files or a branch
705 :`tg files`_: Show files changed by a TopGit branch
706 :`tg help`_: Show TopGit help optionally using a browser
707 :`tg import`_: Import commit(s) to separate TopGit branches
708 :`tg info`_: Show status information about a TopGit branch
709 :`tg log`_: Run git log limiting revisions to a TopGit branch
710 :`tg mail`_: Shortcut for git send-email with ``tg patch`` output
711 :`tg migrate-bases`_: Transition top-bases to new location
712 :`tg next`_: Show branches directly depending on a TopGit branch
713 :`tg patch`_: Generate a patch file for a TopGit branch
714 :`tg prev`_: Show non-annihilated TopGit dependencies for a branch
715 :`tg push`_: Run git push on TopGit branch(es) and depedencies
716 :`tg rebase`_: Auto continue git rebase if rerere resolves conflicts
717 :`tg remote`_: Set up remote for fetching/pushing TopGit branches
718 :`tg revert`_: Revert ref(s) to a state stored in a ``tg tag``
719 :`tg status`_: Show current TopGit status (e.g. in-progress update)
720 :`tg summary`_: Show various information about TopGit branches
721 :`tg tag`_: Create tag that records current TopGit branch state
722 :`tg update`_: Update TopGit branch(es) with respect to dependencies
726 Our sophisticated integrated help facility. Mostly duplicates
731 # to get help for a particular command:
733 # to get help for a particular command in a browser window:
734 $ tg help -w <command>
735 # to get help on TopGit itself
737 # to get help on TopGit itself in a browser
742 Our sophisticated status facility. Similar to Git's status command
743 but shows any in-progress update that's awaiting a merge resolution
744 or any other on-going TopGit activity (such as a branch creation).
746 With a single ``--verbose`` (or ``-v``) option include a short status
747 display for any dirty (but not untracked) files. This also causes all
748 non file status lines to be prefixed with "## ".
750 With two (or more) ``--verbose`` (or ``-v``) options, additionally
751 show full symbolic ref names and unabbreviated hash values.
753 With the ``--exit-code`` option the exit code will be non-zero if any
754 TopGit or Git operation is currently in progress or the working
759 Create a new TopGit-controlled topic branch of the given name
760 (required argument) and switch to it. If no dependencies are
761 specified (by extra arguments passed after the first one), the
762 current branch is assumed to be the only dependency.
764 By default ``tg create`` opens an editor on the new ``.topmsg`` file
765 and then commits the new ``.topmsg`` and ``.topdeps`` files
766 automatically with a suitable default commit message.
768 The commit message can be changed with the ``-m`` (or ``--message``) or
769 ``-F`` (or ``--file``) option. The automatic commit can be suppressed
770 by using the ``--no-ccmmit`` option. Running the editor on the new
771 ``.topmsg`` file can be suppressed by using ``-n`` (or ``--no-edit``)
772 (which also suppresses the automatic commit) or by providing an
773 explicit value for the new ``.topmsg`` file using the ``--topmsg`` or
774 ``--topmsg-file`` option. In any case the ``.topmsg`` content will be
775 automatically reformated to have a ``Subject:`` header line if needed.
777 If more than one dependency is listed, the automatic commit will not
778 take place until AFTER all the listed dependencies have been merged
779 into a base commit which will require some manual merge resolutions if
780 conflicts occur during the merge operations.
782 Previous versions of TopGit behaved as though the ``--no-edit`` option
783 was always given on the command line.
785 The default behavior has been changed to promote a separation between
786 commits that modify ``.topmsg`` and/or ``.topdeps`` and commits that
787 modify other files. This facilitates cleaner cherry picking and other
788 patch maintenance activities.
790 You should edit the patch description (contained in the ``.topmsg``
791 file) as appropriate. It will already contain some prefilled bits.
792 You can set the ``topgit.to``, ``topgit.cc`` and ``topgit.bcc``
793 git configuration variables (see ``man git-config``) in order to
794 have ``tg create`` add these headers with the given default values
795 to ``.topmsg`` before invoking the editor.
797 The main task of ``tg create`` is to set up the topic branch base
798 from the dependencies. This may fail due to merge conflicts if more
799 than one dependency is given. In that case, after you commit the
800 conflict resolution, you should call ``tg update --continue`` to
801 finish merging the dependencies into the new topic branch base.
803 With the ``--base`` (aka ``--no-deps``) option at most one dependency
804 may be listed which may be any valid committish (instead of just
805 refs/heads/...) and the newly created TopGit-controlled branch will
806 have an empty ``.topdeps`` file. This may be desirable in order to
807 create a TopGit-controlled branch that has no changes of its own and
808 serves merely to mark the common dependency that all other
809 TopGit-controlled branches in some set of TopGit-controlled branches
810 depend on. A plain, non-TopGit-controlled branch can be used for the
811 same purpose, but the advantage of a TopGit-controlled branch with no
812 dependencies is that it will be pushed with ``tg push``, it will show
813 up in the ``tg summary`` and ``tg info`` output with the subject from
814 its ``.topmsg`` file thereby documenting what it's for and finally it
815 can be set up with ``tg create -r`` and/or ``tg remote --populate`` to
818 For example, ``tg create --base release v2.1`` will create a TopGit-
819 controlled ``release`` branch based off the ``v2.1`` tag that can then
820 be used as a base for creation of other TopGit-controlled branches.
821 Then when the time comes to move the base for an entire set of changes
822 up to ``v2.2`` the command ``tg update --base release v2.2`` can be
823 used followed by ``tg update --all``.
825 Using ``--base`` it's also possible to use ``tg create`` on an
826 unborn branch (omit the dependency name or specify ``HEAD``). The
827 unborn branch itself can be made into the new TopGit branch (rather
828 than being born empty and then having the new TopGit branch based off
829 that) by specifying ``HEAD`` as the new branch's name (which is
830 probably what you normally want to do in this case anyway so you can
831 just run ``tg create --base HEAD`` to accomplish that).
833 In an alternative use case, if ``-r <branch>`` is given instead of a
834 dependency list, the topic branch is created based on the given
835 remote branch. With just ``-r`` the remote branch name is assumed
836 to be the same as the local topic branch being created. Since no
837 new commits are created in this mode (only two refs will be updated)
838 the editor will never be run for this use case. Note that no other
839 options may be combined with ``-r``.
841 The ``--quiet`` (or ``-q``) option suppresses most informational
846 Remove a TopGit-controlled topic branch of the given name
847 (required argument). Normally, this command will remove only an
848 empty branch (base == head) without dependendents; use ``-f`` to
849 remove a non-empty branch or a branch that is depended upon by
852 The ``-f`` option is also useful to force removal of a branch's
853 base, if you used ``git branch -D B`` to remove branch B, and then
854 certain TopGit commands complain, because the base of branch B
857 Normally ``tg delete`` will refuse to delete the current branch.
858 However, giving ``-f`` twice (or more) will force it to do so but it
859 will first detach your HEAD.
861 IMPORTANT: Currently, this command will *NOT* remove the branch
862 from the dependency list in other branches. You need to take
863 care of this *manually*. This is even more complicated in
864 combination with ``-f`` -- in that case, you need to manually
865 unmerge the removed branch's changes from the branches depending
868 See also ``tg annihilate``.
870 | TODO: ``-a`` to delete all empty branches, depfix, revert
874 Make a commit on the current TopGit-controlled topic branch
875 that makes it equal to its base, including the presence or
876 absence of .topmsg and .topdeps. Annihilated branches are not
877 displayed by ``tg summary``, so they effectively get out of your
878 way. However, the branch still exists, and ``tg push`` will
879 push it (except if given the ``-a`` option). This way, you can
880 communicate that the branch is no longer wanted.
882 When annihilating a branch that has dependents (i.e. branches
883 that depend on it), those dependents have the dependencies of
884 the branch being annihilated added to them if they do not already
885 have them as dependencies. Essentially the DAG is repaired to
886 skip over the annihilated branch.
888 Normally, this command will remove only an empty branch
889 (base == head, except for changes to the .top* files); use
890 ``-f`` to annihilate a non-empty branch.
892 After completing the annihilation itself, normally ``tg update``
893 is run on any modified dependents. Use the ``--no-update`` option
894 to suppress running ``tg update``.
898 Change the dependencies of a TopGit-controlled topic branch.
899 This should have several subcommands, but only ``add`` is
902 The ``add`` subcommand takes an argument naming a topic branch to
903 be added, adds it to ``.topdeps``, performs a commit and then
904 updates your topic branch accordingly. If you want to do other
905 things related to the dependency addition, like adjusting
906 ``.topmsg``, use the option ``--no-commit``. Adding the
907 ``--no-update`` (or ``--no-commit``) option will suppress the
908 ``tg update`` normally performed after committing the change.
910 It is safe to run ``tg depend add`` in a dirty worktree, but the
911 normally performed ``tg update`` will be suppressed in that case
912 (even if neither ``--no-update`` nor ``--no-commit`` is given).
914 You have enabled ``git rerere`` haven't you?
916 | TODO: Subcommand for removing dependencies, obviously
920 List files changed by the current or specified topic branch.
923 -i list files based on index instead of branch
924 -w list files based on working tree instead of branch
928 Show summary information about the current or specified topic
931 Numbers in parenthesis after a branch name such as "(11/3 commits)"
932 indicate how many commits on the branch (11) and how many of those
933 are non-merge commits (3).
935 With ``--verbose`` (or ``-v``) include a list of dependents (i.e. other
936 branches that depend on this one). Another ``--verbose`` annotates
937 them with "[needs merge]" if the current tip of branch for which info
938 is being shown has not yet been merged into the base of the dependent.
940 Alternatively, if ``--heads`` is used then which of the independent
941 TopGit branch heads (as output by ``tg summary --topgit-heads``)
942 logically contains the specified commit (which may be any committish --
943 defaults to ``HEAD`` if not given). Zero or more results will be
944 output. Note that "logically" means with regard to the TopGit
945 dependency relationships as established by the ``.topdeps`` file(s).
946 It's the answer that would be given when all the TopGit branches are
947 up-to-date (even though they need not be to use this option) and the
948 ``git branch --contains`` command is run and the output then filtered
949 to only those branches that appear in ``tg summary --topgit-heads``.
950 This computation may require several seconds on complex repositories.
952 If ``--leaves`` is used then the unique list of leaves of the current
953 or specified topic branch is shown as one fully-qualified ref per line.
954 Duplicates are suppressed and a tag name will be used when appropriate.
955 A "leaf" is any dependency that is either not a TopGit branch or is
956 the base of a non-annihilated TopGit branch with no non-annihilated
959 The ``--deps`` option shows non-annihilated TopGit dependencies of the
960 specified branch (default is ``HEAD``).
962 The ``--dependents`` option shows non-annihilated TopGit dependents
963 (i.e. branches that depend on the specified branch). The default
964 branch to operate on is again ``HEAD``.
966 A linearized patch series can only be automatically created for a
967 TopGit topic branch (including its recursive dependencies) when exactly
968 one line is output by ``tg info --leaves <topic-branch>``.
970 With ``--series`` the list of TopGit branches in the order they would
971 be linearized into a patch series is shown along with the description
972 of each branch. If branch name passed to ``tg info`` is not the last
973 branch in the series a marker column will be provided to quickly
974 locate it in the list. This same option can be used with `tg checkout`_.
976 Some patches shown in the list may not actually end up introducing any
977 changes if exported and be therefore end up being omitted. The ``0``
978 indicator in ``tg summary`` output can help to identify some of these.
980 The patches shown in the series in the order they are shown form the
981 basis for the ``tg next`` and ``tg prev`` operations with the first
982 patch shown being considered the first and so on up to the last.
986 Generate a patch from the current or specified topic branch.
987 This means that the diff between the topic branch base and head
988 (latest commit) is shown, appended to the description found in
989 the ``.topmsg`` file.
991 The patch is simply dumped to stdout. In the future, ``tg patch``
992 will be able to automatically send the patches by mail or save
993 them to files. (TODO)
996 -i base patch generation on index instead of branch
997 -w base patch generation on working tree instead of branch
998 --binary pass --binary to ``git diff-tree`` to enable generation
1000 --quiet be quiet (aka ``-q``) about missing and unfixed From:
1001 --from make sure patch has a From: line, if not add one using
1002 --from=<a> <a> or Signed-off-by value or ident value; ``git am``
1003 really gets unhappy with patches missing From: lines;
1004 will NOT replace an existing non-empty From: header
1005 --no-from leave all From: lines alone, missing or not (default)
1006 --diff-opt options after the branch name (and an optional ``--``)
1007 are passed directly to ``git diff-tree``
1009 In order to pass a sole explicit ``-w`` through to ``git diff-tree`` it
1010 must be separated from the ``tg`` options by an explicit ``--``.
1011 Or it can be spelled as ``--ignore-all-space`` to distinguuish it from
1012 ``tg``'s ``-w`` option.
1014 If the config variable ``topgit.from`` is set to a boolean it can be
1015 used to enable or disable the ``--from`` option by default. If it's
1016 set to the speical value ``quiet`` the ``--quiet`` option is enabled
1017 and From: lines are left alone by default. Any other non-empty value
1018 is taken as a default ``--from=<value>`` option. The ``--no-from``
1019 option will temporarily disable use of the config value.
1021 If additional non-``tg`` options are passed through to
1022 ``git diff-tree`` (other than ``--binary`` which is fully supported)
1023 the resulting ``tg patch`` output may not be appliable.
1027 Send a patch from the current or specified topic branch as
1030 Takes the patch given on the command line and emails it out.
1031 Destination addresses such as To, Cc and Bcc are taken from the
1034 Since it actually boils down to ``git send-email``, please refer
1035 to the documentation for that for details on how to setup email
1036 for git. You can pass arbitrary options to this command through
1037 the ``-s`` parameter, but you must double-quote everything. The
1038 ``-r`` parameter with a msgid can be used to generate in-reply-to
1039 and reference headers to an earlier mail.
1041 WARNING: be careful when using this command. It easily sends
1042 out several mails. You might want to run::
1044 git config sendemail.confirm always
1046 to let ``git send-email`` ask for confirmation before sending any
1050 -i base patch generation on index instead of branch
1051 -w base patch generation on working tree instead of branch
1053 | TODO: ``tg mail patchfile`` to mail an already exported patch
1054 | TODO: mailing patch series
1055 | TODO: specifying additional options and addresses on command line
1059 Register the given remote as TopGit-controlled. This will create
1060 the namespace for the remote branch bases and teach ``git fetch``
1061 to operate on them. However, from TopGit 0.8 onwards you need to
1062 use ``tg push``, or ``git push --mirror``, for pushing
1063 TopGit-controlled branches.
1065 ``tg remote`` takes an optional remote name argument, and an
1066 optional ``--populate`` switch. Use ``--populate`` for your
1067 origin-style remotes: it will seed the local topic branch system
1068 based on the remote topic branches. ``--populate`` will also make
1069 ``tg remote`` automatically fetch the remote, and ``tg update`` look
1070 at branches of this remote for updates by default.
1072 Using ``--populate`` with a remote name causes the ``topgit.remote``
1073 git configuration variable to be set to the given remote name.
1077 Show overview of all TopGit-tracked topic branches and their
1078 up-to-date status. With a branch name limit output to that branch.
1079 Using ``--deps-only`` or ``--rdeps`` changes the default from all
1080 related branches to just the current ``HEAD`` branch but using
1081 ``--all`` as the branch name will show results for all branches
1082 instead of ``HEAD``.
1085 marks the current topic branch
1088 indicates that it introduces no changes of its own
1091 indicates respectively whether it is local-only
1092 or has a remote mate
1095 indicates respectively if it is ahead or out-of-date
1096 with respect to its remote mate
1099 indicates that it is out-of-date with respect to its
1103 indicates that it has missing dependencies [even if
1104 they are recursive ones]
1107 indicates that it is out-of-date with respect to
1111 indicates it is ahead of (and needs to be merged into)
1112 at least one of its dependents -- only computed when
1113 showing all branches or using the (possibly implied)
1114 ``--with-deps`` option.
1116 This can take a longish time to accurately determine all the
1117 relevant information about each branch; you can pass ``-t`` (or ``-l``
1118 or ``--list``) to get just a terse list of topic branch names quickly.
1119 Also adding ``--verbose`` (or ``-v``) includes the subjects too.
1121 If no options or arguments are passed, the default is not actually to
1122 show ``--all`` branches (that was the default once upon a time).
1123 Instead, the default is essentially ``--with-deps $(tg info --heads)``
1124 with a fallback to ``--all`` if ``tg info`` doesn't give up any heads.
1125 This usually provides a more intuitive result. Explicitly using
1126 ``--all`` will always show all branches (related or not to ``HEAD``).
1128 Passing ``--heads`` shows independent topic branch names and when
1129 combined with ``--rdeps`` behaves as though ``--rdeps`` were run with
1130 the output of ``--heads``.
1132 The ``--heads-independent`` option works just like ``--heads`` except
1133 that it computes the heads using ``git merge-base --independent``
1134 rather than examining the TopGit ``.topdeps`` relationships. If the
1135 TopGit branches are all up-to-date (as shown in ``tg summary``) then
1136 both ``--heads`` and ``--heads-independent`` should compute the same
1137 list of heads (unless some overlapping TopGit branches have been
1138 manually created). If not all the TopGit branches are up-to-date then
1139 the ``--heads-independent`` results may have extra items in it, but
1140 occasionally that's what's needed; usually it's the wrong answer.
1141 (Note that ``--topgit-heads`` is accepted as an alias for ``--heads``
1144 Using ``--heads-only`` behaves as though the output of ``--heads`` was
1145 passed as the list of branches along with ``--without-deps``.
1147 Alternatively, you can pass ``--graphviz`` to get a dot-suitable output
1148 for drawing a dependency graph between the topic branches.
1150 You can also use the ``--sort`` option to sort the branches using
1151 a topological sort. This is especially useful if each
1152 TopGit-tracked topic branch depends on a single parent branch,
1153 since it will then print the branches in the dependency order.
1154 In more complex scenarios, a text graph view would be much more
1155 useful, but that has not yet been implemented.
1157 The ``--deps`` option outputs dependency information between
1158 branches in a machine-readable format. Feed this to ``tsort`` to
1159 get the output from --sort.
1161 The ``--deps-only`` option outputs a sorted list of the unique branch
1162 names given on the command line plus all of their recursive
1163 dependencies (subject to ``--exclude`` of course). When
1164 ``--deps-only`` is given the default is to just display information for
1165 ``HEAD``, but that can be changed by using ``--all`` as the branch
1166 name. Each branch name will appear only once in the output no matter
1167 how many times it's visited while tracing the dependency graph or how
1168 many branch names are given on the command line to process.
1170 The ``--rdeps`` option outputs dependency information in an indented
1171 text format that clearly shows all the dependencies and their
1172 relationships to one another. When ``--rdeps`` is given the default is
1173 to just display information for ``HEAD``, but that can be changed by
1174 using ``--all`` as the branch name or by adding the ``--heads`` option.
1175 Note that ``tg summary --rdeps --heads`` can be particularly helpful in
1176 seeing all the TopGit-controlled branches in the repository and their
1177 relationships to one another.
1179 Note that ``--rdeps`` has two flavors. The first (and default) is
1180 ``--rdeps-once`` which only shows the dependencies of a branch when
1181 it's first visited. For example, if D depends on several other
1182 branches perhaps recursively and both branch A and B depend on D, then
1183 whichever of A or B is shown first will show the entire dependency
1184 chain for D underneath it and the other one will just show a line for
1185 D itself. This can make the output a bit more compact without actually
1186 losing any information which is why it's the default. However, using
1187 the ``--rdeps-full`` variant will repeat the full dependency chain
1188 every time it's encountered.
1190 Adding ``--with-deps`` replaces the given list of branches (which will
1191 default to ``HEAD`` if none are given) with the result of running
1192 ``tg summary --deps-only --tgish`` on the list of branches. This can
1193 be helpful in limiting ``tg summary`` output to only the list of given
1194 branches and their dependencies when many TopGit-controlled branches
1195 are present in the repository. When it would be allowed,
1196 ``--with-deps`` is now the default. Use ``--without-deps`` to switch
1197 back to the old behavior.
1199 With ``--exclude branch``, branch can be excluded from the output
1200 meaning it will be skipped and its name will be omitted from any
1201 dependency output. The ``--exclude`` option may be repeated to omit
1202 more than one branch from the output. Limiting the output to a single
1203 branch that has been excluded will result in no output at all.
1205 The ``--tgish-only`` option behaves as though any non-TopGit-controlled
1206 dependencies encountered during processing had been listed after an
1207 ``--exclude`` option.
1209 Note that the branch name can be specified as ``HEAD`` or ``@`` as a
1210 shortcut for the TopGit-controlled branch that ``HEAD`` is a
1211 symbolic ref to. The ``tg summary @`` command can be quite useful.
1214 -i Use TopGit metadata from the index instead of the branch
1215 -w Use TopGit metadata from the working tree instead of the branch
1219 Search all TopGit-controlled branches (and optionally their remotes)
1220 to find which TopGit-controlled branch contains the specified commit.
1222 This is more than just basic branch containment as provided for by the
1223 ``git branch --contains`` command. While the shown branch name(s)
1224 will, indeed, be one (or more) of those output by the
1225 ``git branch --contains`` command, the result(s) will exclude any
1226 TopGit-controlled branches from the result(s) that have one (or more)
1227 of their TopGit dependencies (either direct or indirect) appearing in
1228 the ``git branch --contains`` output.
1230 Normally the result will be only the one, single TopGit-controlled
1231 branch for which the specified committish appears in the ``tg log``
1232 output for that branch (unless the committish lies outside the
1233 TopGit-controlled portion of the DAG and ``--no-strict`` was used).
1235 Unless ``--annihilated-okay`` (or ``--ann`` or ``--annihilated``) is
1236 used then annihilated branches will be immediately removed from the
1237 ``git branch --contains`` output before doing anything else. This
1238 means a committish that was originally located in a now-annihilated
1239 branch will show up in whatever branch picked up the annihilated
1240 branch's changes (if there is one). This is usually the correct
1241 answer, but occasionally it's not; hence this option. If this option
1242 is used together with ``--verbose`` then annihilated branches will
1243 be shown as "[:annihilated:]".
1245 In other words, if a ``tg patch`` is generated for the found branch
1246 (assuming one was found and a subsequent commit in the same branch
1247 didn't then revert or otherwise back out the change), then that patch
1248 will include the changes introduced by the specified committish
1249 (unless, of course, that committish is outside the TopGit-controlled
1250 portion of the DAG and ``--no-strict`` was given).
1252 This can be very helpful when, for example, a bug is discovered and
1253 then after using ``git bisect`` (or some other tool) to find the
1254 offending commit it's time to commit the fix. But because the
1255 TopGit merging history can be quite complicated and maybe the one
1256 doing the fix wasn't the bug's author (or the author's memory is just
1257 going), it can sometimes be rather tedious to figure out which
1258 TopGit branch the fix belongs in. The ``tg contains`` command can
1259 quickly tell you the answer to that question.
1261 With the ``--remotes`` (or ``-r``) option a TopGit-controlled remote
1262 branch name may be reported as the result but only if there is no
1263 non-remote branch containing the committish (this can only happen
1264 if at least one of the TopGit-controlled local branches are not yet
1265 up-to-date with their remotes).
1267 With the ``--verbose`` option show which TopGit DAG head(s) (one or
1268 more of the TopGit-controlled branch names output by
1269 ``tg summary --heads``) have the result as a dependency (either direct
1270 or indirect). Using this option will noticeably increase running time.
1272 With the default ``--strict`` option, results for which the base of the
1273 TopGit-controlled branch contains the committish will be suppressed.
1274 For example, if the committish was deep-down in the master branch
1275 history somewhere far outside of the TopGit-controlled portion of
1276 the DAG, with ``--no-strict``, whatever TopGit-controlled branch(es)
1277 first picked up history containing that committish will be shown.
1278 While this is a useful result it's usually not the desired result
1279 which is why it's not the default.
1281 To summarize, even with ``--remotes``, remote results are only shown
1282 if there are no non-remote results. Without ``--no-strict`` (because
1283 ``--strict`` is the default) results outside the TopGit-controlled
1284 portion of the DAG are never shown and even with ``--no-strict`` they
1285 will only be shown if there are no ``--strict`` results. Finally,
1286 the TopGit head info shown with ``--verbose`` only ever appears for
1287 local (i.e. not a remote branch) results. Annihilated branches are
1288 never considered possible matches without ``--annihilated-okay``.
1292 Switch to a topic branch. You can use ``git checkout <branch>``
1293 to get the same effect, but this command helps you navigate
1294 the dependency graph, or allows you to match the topic branch
1295 name using a regular expression, so it can be more convenient.
1297 The ``--branch`` (or ``-b`` or ``--branch=<name>``) option changes
1298 the default starting point from ``HEAD`` to the specified branch.
1300 For the "next" and "previous" commands, the ``<steps>`` value may
1301 be ``--all`` (or ``-a``) to take "As nany steps As possible" or
1302 "step ALL the way" or "ALL steps at once" (or make something better
1305 The following subcommands are available:
1307 ``tg checkout next [<steps>]``
1308 Check out a branch that directly
1309 depends on your current branch.
1310 Move ``<steps>`` (default 1) step(s) in
1311 the "next" direction (AKA ``n``).
1313 ``tg checkout prev [<steps>]``
1314 Check out a branch that this branch
1315 directly depends on. Move ``<steps>``
1316 (default 1) step(s) in the "previous"
1317 direction (AKA ``p`` or ``previous``).
1319 ``tg checkout [goto] [--] <pattern>``
1320 Check out a topic branch that
1321 matches ``<pattern>``. ``<pattern>``
1322 is used as a grep ERE pattern to filter
1323 all the topic branches. Both ``goto`` and
1324 ``--`` may be omitted provided ``<pattern>``
1325 is not ``-a``, ``--all``, ``-h``, ``--help``,
1326 ``goto``, ``--``, ``n``, ``next``, ``push``,
1327 ``child``, ``p``, ``prev``, ``previous``,
1328 ``pop``, ``parent`` or ``..``.
1330 ``tg checkout [goto] [--] --series[=<head>]``
1331 Check out a topic branch that belongs to
1332 the current (or ``<head>``) patch series.
1333 A list with descriptions (``tg info --series``)
1334 will be shown to choose from if more than one.
1336 ``tg checkout push [<steps>]``
1337 An alias for ``next``.
1339 ``tg checkout child [<steps>]``
1340 Deprecated alias for ``next``.
1343 Semi-deprecated alias for ``next``.
1345 ``tg checkout pop [<steps>]``
1346 An alias for ``prev``.
1348 ``tg checkout parent [<steps>]``
1349 Deprecated alias for ``prev``.
1351 ``tg checkout .. [<steps>]``
1352 Semi-deprecated alias for ``prev``.
1354 If any of the above commands can find more than one possible
1355 branch to switch to, you will be presented with the matches
1356 and asked to select one of them.
1358 If the ``--ignore-other-worktrees`` (or ``--iow``) option is given and
1359 the current Git version is at least 2.5.0 then the full
1360 ``--ignore-other-worktrees`` option will be passed along to the
1361 ``git checkout`` command when it's run (otherwise the option will be
1362 silently ignored and not passed to Git as it would cause an error).
1364 The ``--force`` (or ``-f``) option, when given, gets passed through to
1365 the ``git checkout`` command.
1367 The ``<pattern>`` of ``tg checkout goto`` is optional. If you don't
1368 supply it, all the available topic branches are listed and you
1369 can select one of them.
1371 Normally, the ``push`` and ``pop`` commands moves one step in
1372 the dependency graph of the topic branches. The ``-a`` option
1373 causes them (and their aliases) to move as far as possible.
1374 That is, ``tg checkout push -a`` moves to a topic branch that
1375 depends (directly or indirectly) on the current branch and
1376 that no other branch depends on. ``tg checkout pop -a``
1377 moves to a regular branch that the current topic branch
1378 depends on (directly or indirectly). If there is more than
1379 one possibility, you will be prompted for your selection.
1381 See also NAVIGATION_.
1385 Export a tidied-up history of the current topic branch and its
1386 dependencies, suitable for feeding upstream. Each topic branch
1387 corresponds to a single commit or patch in the cleaned up
1388 history (corresponding basically exactly to ``tg patch`` output
1389 for the topic branch).
1391 The command has three possible outputs now -- either a Git branch
1392 with the collapsed history, a Git branch with a linearized
1393 history, or a quilt series in new directory.
1395 In the case where you are producing collapsed history in a new
1396 branch, you can use this collapsed structure either for
1397 providing a pull source for upstream, or for further
1398 linearization e.g. for creation of a quilt series using git log::
1400 git log --pretty=email -p --topo-order origin..exported
1402 To better understand the function of ``tg export``, consider this
1403 dependency structure::
1405 origin/master - t/foo/blue - t/foo/red - master
1406 `- t/bar/good <,----------'
1407 `- t/baz ------------'
1409 (where each of the branches may have a hefty history). Then::
1411 master$ tg export for-linus
1413 will create this commit structure on the branch ``for-linus``::
1415 origin/master - t/foo/blue -. merge - t/foo/red -.. merge - master
1416 `- t/bar/good <,-------------------'/
1417 `- t/baz ---------------------'
1419 In this mode, ``tg export`` works on the current topic branch, and
1420 can be called either without an option (in that case,
1421 ``--collapse`` is assumed), or with the ``--collapse`` option, and
1422 with one mandatory argument: the name of the branch where the
1423 exported result will be stored.
1425 When using the linearize mode::
1427 master$ tg export --linearize for-linus
1429 you get a linear history respecting the dependencies of your
1430 patches in a new branch ``for-linus``. The result should be more
1431 or less the same as using quilt mode and then reimporting it
1432 into a Git branch. (More or less because the topological order
1433 can usually be extended in more than one way into a total order,
1434 and the two methods may choose different ones.) The result
1435 might be more appropriate for merging upstream, as it contains
1438 Note that you might get conflicts during linearization because
1439 the patches are reordered to get a linear history. If linearization
1440 would produce conflicts then using ``--quilt`` will also likely result
1441 in conflicts when the exported quilt series is applied. Since the
1442 ``--quilt`` mode simply runs a series of ``tg patch`` commands to
1443 generate the patches in the exported quilt series and those patches
1444 will end up being applied linearly, the same conflicts that would be
1445 produced by the ``--linearize`` option will then occur at that time.
1447 To avoid conflicts produced by ``--linearize`` (or by applying the
1448 ``--quilt`` output), use the default ``--collapse`` mode and then use
1449 ``tg rebase`` (or ``git rebase -m`` directly) on the collapsed branch
1450 (with a suitable <upstream>) followed by ``git format-patch`` on the
1451 rebased result to produce a conflict-free patch set. A suitable
1452 upstream may be determined with the ``tg info --leaves`` command (if
1453 it outputs more than one line, linearization will be problematic).
1455 You have enabled ``git rerere`` haven't you?
1457 When using the quilt mode::
1459 master$ tg export --quilt for-linus
1461 would create the following directory ``for-linus``::
1463 for-linus/t/foo/blue.diff
1464 for-linus/t/foo/red.diff
1465 for-linus/t/bar/good.diff
1466 for-linus/t/baz.diff
1473 With ``--quilt``, you can also pass the ``-b`` parameter followed
1474 by a comma-separated explicit list of branches to export, or
1475 the ``--all`` parameter (which can be shortened to ``-a``) to
1476 export them all. The ``--binary`` option enables producing Git
1477 binary patches. These options are currently only supported
1480 In ``--quilt`` mode the patches are named like the originating
1481 topgit branch. So usually they end up in subdirectories of the
1482 output directory. With the ``--flatten`` option the names are
1483 mangled so that they end up directly in the output dir (slashes
1484 are replaced with underscores). With the ``--strip[=N]`` option
1485 the first ``N`` subdirectories (all if no ``N`` is given) get
1486 stripped off. Names are always ``--strip``'d before being
1487 ``--flatten``'d. With the option ``--numbered`` (which implies
1488 ``--flatten``) the patch names get a number as prefix to allow
1489 getting the order without consulting the series file, which
1490 eases sending out the patches.
1492 | TODO: Make stripping of non-essential headers configurable
1493 | TODO: Make stripping of [PATCH] and other prefixes configurable
1494 | TODO: ``--mbox`` option to export instead as an mbox file
1495 | TODO: support ``--all`` option in other modes of operation
1496 | TODO: For quilt exporting, export the linearized history created in
1497 a temporary branch--this would allow producing conflict-less
1502 Import commits within the given revision range into TopGit,
1503 creating one topic branch per commit. The dependencies are set
1504 up to form a linear sequence starting on your current branch --
1505 or a branch specified by the ``-d`` parameter, if present.
1507 The branch names are auto-guessed from the commit messages and
1508 prefixed by ``t/`` by default; use ``-p <prefix>`` to specify an
1509 alternative prefix (even an empty one).
1511 Alternatively, you can use the ``-s NAME`` parameter to specify
1512 the name of the target branch; the command will then take one
1513 more argument describing a *single* commit to import.
1517 Update the current, specified or all topic branches with respect
1518 to changes in the branches they depend on and remote branches.
1519 This is performed in two phases -- first, changes within the
1520 dependencies are merged to the base, then the base is merged
1521 into the topic branch. The output will guide you on what to do
1522 next in case of conflicts.
1524 You have enabled ``git rerere`` haven't you?
1526 The ``--[no-]auto[-update]`` options together with the
1527 ``topgit.setAutoUpdate`` config item control whether or not TopGit
1528 will automatically temporarily set ``rerere.autoUpdate`` to true while
1529 running ``tg update``. The default is true. Note that this does not
1530 enable Git's ``rerere`` feature, it merely makes it automatically stage
1531 any previously resolved conflicts. The ``rerere.enabled`` setting must
1532 still be separately enabled (i.e. set to ``true``) for the ``rerere``
1533 feature to do anything at all.
1535 Using ``--auto[-update]`` makes ``tg update`` always temporarily set
1536 ``rerere.autoUpdate`` to ``true`` while running ``tg update``. The
1537 ``--no-auto[-update]`` option prevents ``tg update`` from changing the
1538 ``rerere.autoUpdate`` setting, but if ``rerere.autoUpdate`` has already
1539 been enabled in a config file, ``tg update`` never disables it even
1540 with ``--no-auto``. If ``topgit.setAutoUpdate`` is unset or set to
1541 ``true`` then ``tg update`` implicitly does ``--auto``, otherwise it
1542 does ``--no-auto``. An explicit command line ``--[no-]auto[-update]``
1543 option causes the ``topgit.setAutoUpdate`` setting to be ignored.
1545 When both ``rerere.enabled`` and ``rerere.autoUpdate`` are set to true
1546 then ``tg update`` will be able to automatically continue an update
1547 whenever ``git rerere`` resolves all the conflicts during a merge.
1548 This can be such a huge time saver. That's why the default is to have
1549 TopGit automatically set ``rerere.autoUpdate`` to true while
1550 ``tg update`` is running (but remember, unless ``rerere.enabled`` has
1551 been set to ``true`` it won't make any difference).
1553 When ``-a`` (or ``--all``) is specifed, updates all topic branches
1554 matched by ``<pattern>``'s (see ``git-for-each-ref(1)`` for details),
1555 or all if no ``<pattern>`` is given. Any topic branches with missing
1556 dependencies will be skipped entirely unless ``--skip-missing`` is
1559 When ``--skip-missing`` is specifed, an attempt is made to update topic
1560 branches with missing dependencies by skipping only the dependencies
1561 that are missing. Caveat utilitor.
1563 When ``--stash`` is specified (or the ``topgit.autostash`` config
1564 value is set to ``true``), a ref stash will be automatically created
1565 just before beginning updates if any are needed. The ``--no-stash``
1566 option may be used to disable a ``topgit.autostash=true`` setting.
1567 See the ``tg tag`` ``--stash`` option for details.
1569 After the update, if a single topic branch was specified, it is
1570 left as the current one; if ``-a`` was specified, it returns to
1571 the branch which was current at the beginning.
1573 If your dependencies are not up-to-date, ``tg update`` will first
1574 recurse into them and update them.
1576 If a remote branch update brings in dependencies on branches
1577 that are not yet instantiated locally, you can either bring in
1578 all the new branches from the remote using ``tg remote
1579 --populate``, or only pick out the missing ones using ``tg create
1580 -r`` (``tg summary`` will point out branches with incomplete
1581 dependencies by showing an ``!`` next to them). TopGit will attempt to
1582 instantiate just the missing ones automatically for you, if possible,
1583 when ``tg update`` merges in the new dependencies from the remote.
1585 Using the alternative ``--base`` mode, ``tg update`` will update
1586 the base of a specified ``[BASE]`` branch (which is a branch created
1587 by ``tg create`` using the ``--base`` option) to the specified
1588 committish (the second argument) and then immediately merge that into
1589 the branch itself using the specified message for the merge commit.
1590 If no message is specified on the command line, an editor will open.
1591 Unless ``--force`` is used the new value for the base must contain
1592 the old value (i.e. be a fast-forward update). This is for safety.
1594 This mode makes updates to ``[BASE]`` branches quick and easy.
1596 | TODO: ``tg update -a -c`` to autoremove (clean) up-to-date branches
1600 If ``-a`` or ``--all`` was specified, pushes all non-annihilated
1601 TopGit-controlled topic branches, to a remote repository.
1602 Otherwise, pushes the specified topic branches -- or the
1603 current branch, if you don't specify which. By default, the
1604 remote gets all the dependencies (both TopGit-controlled and
1605 non-TopGit-controlled) and bases pushed to it too. If
1606 ``--tgish-only`` was specified, only TopGit-controlled
1607 dependencies will be pushed, and if ``--no-deps`` was specified,
1608 no dependencies at all will be pushed.
1610 The ``--dry-run`` and ``--force`` options are passed directly to
1611 ``git push`` if given.
1613 The remote may be specified with the ``-r`` option. If no remote
1614 was specified, the configured default TopGit remote will be
1619 Prints the base commit of each of the named topic branches, or
1620 the current branch if no branches are named. Prints an error
1621 message and exits with exit code 1 if the named branch is not
1626 Prints the git log of the named topgit branch -- or the current
1627 branch, if you don't specify a name.
1629 This is really just a convenient shortcut for:
1631 ``git log --first-parent --no-merges $(tg base <name>)..<name>``
1633 where ``<name>`` is the name of the TopGit topic branch (or omitted
1634 for the current branch).
1636 However, if ``<name>`` is a ``[BASE]`` branch the ``--no-merges``
1639 If ``--compact`` is used then ``git log-compact`` will be used instead
1640 of ``git log``. The ``--command=<git-alias>`` option can be used to
1641 replace "log" with any non-whitespace-containing command alias name,
1642 ``--compact`` is just a shortcut for ``--command=log-compact``. The
1643 ``git-log-compact`` tool may be found on its project page located at:
1645 https://mackyle.github.io/git-log-compact
1647 Note that the ``--compact`` or ``--command=`` option must be used
1648 before any ``--`` or ``git log`` options to be recognized.
1650 NOTE: if you have merged changes from a different repository, this
1651 command might not list all interesting commits.
1655 Creates a TopGit annotated/signed tag or lists the reflog of one.
1657 A TopGit annotated tag records the current state of one or more TopGit
1658 branches and their dependencies and may be used to revert to the tagged
1659 state at any point in the future.
1661 When reflogs are enabled (the default in a non-bare repository) and
1662 combined with the ``--force`` option a single tag name may be used as a
1663 sort of TopGit branch state stash. The special branch name ``--all``
1664 may be used to tag the state of all current TopGit branches to
1665 facilitate this function and has the side-effect of suppressing the
1666 out-of-date check allowing out-of-date branches to be included.
1668 As a special feature, ``--stash`` may be used as the tag name in which
1669 case ``--all`` is implied if no branch name is listed (instead of the
1670 normal default of ``HEAD``), ``--force`` and ``--no-edit`` (use
1671 ``--edit`` to change that) are automatically activated and the tag will
1672 be saved to ``refs/tgstash`` instead of ``refs/tags/<tagname>``.
1673 The ``--stash`` tag name may also be used with the ``-g``/``--reflog``
1676 The mostly undocumented option ``--allow-outdated`` will bypass the
1677 out-of-date check and is implied when ``--stash`` or ``--all`` is used.
1679 A TopGit annotated/signed tag is simply a Git annotated/signed tag with
1680 a "TOPGIT REFS" section appended to the end of the tag message (and
1681 preceding the signature for signed tags). PEM-style begin and end
1682 lines surround one line per ref where the format of each line is
1683 full-hash SP ref-name. A line will be included for each branch given
1684 on the command line and each ref they depend on either directly or
1687 If more than one TopGit branch is given on the command line, a new
1688 commit will be created that has an empty tree and all of the given
1689 TopGit branches as parents and that commit will be tagged. If a single
1690 TopGit branch is given, then it will be tagged. If the ``--tree``
1691 option is used then it will be used instead of an empty tree (a new
1692 commit will be created if necessary to guarantee the specified tree is
1693 what's in the commit the newly created tag refers to). The argument to
1694 the ``--tree`` option may be any valid treeish.
1696 If exactly one of the branches to be tagged is prefixed with a tilde
1697 (``~``) it will be made the first parent of a consolidation commit if
1698 it is not already the sole commit needing to be tagged. If ``--tree``
1699 is NOT used, its tree will also be used instead of the empty tree for
1700 any new consolidation commit if one is created. Note that if
1701 ``--tree`` is given explicitly it's tree is always used but that does
1702 not in any way affect the choice of first parent. Beware that the
1703 ``~`` may need to be quoted to prevent the shell from misinterpreting
1704 it into something else.
1706 All the options for creating a tag serve the same purpose as their Git
1707 equivalents except for two. The ``--refs`` option suppresses tag
1708 creation entirely and emits the "TOPGIT REFS" section that would have
1709 been included with the tag. If the ``--no-edit`` option is given and
1710 no message is supplied (via the ``-m`` or ``-F`` option) then the
1711 default message created by TopGit will be used without running the
1714 With ``-g`` or ``--reflog`` show the reflog for a tag. With the
1715 ``--reflog-message`` option the message from the reflog is shown.
1716 With the ``--commit-message`` option the first line of the tag's
1717 message (if the object is a tag) or the commit message (if the object
1718 is a commit) falling back to the reflog message for tree and blob
1719 objects is shown. The default is ``--reflog-message`` unless the
1720 ``--stash`` (``refs/tgstash``) is being shown in which case the default
1721 is then ``--commit-message``. Just add either option explicitly to
1722 override the default.
1724 When showing reflogs, non-tag entries are annotated with their type
1725 unless ``--no-type`` is given.
1727 TopGit tags are created with a reflog if core.logallrefupdates is
1728 enabled (the default for non-bare repositories). Unfortunately Git
1729 is incapable of showing an annotated/signed tag's reflog
1730 (using git log -g) as it will first resolve the tag before checking to
1731 see if it has a reflog. Git can, however, show reflogs for lightweight
1732 tags (using git log -g) just fine but that's not helpful here. Use
1733 ``tg tag`` with the ``-g`` or ``--reflog`` option to see the reflog for
1734 an actual tag object. This also works on non-TopGit annotated/signed
1735 tags as well provided they have a reflog.
1737 The number of entries shown may be limited with the ``-n`` option. If
1738 the tagname is omitted then ``--stash`` is assumed.
1740 The ``--delete`` option is a convenience option that runs the
1741 ``git update-ref -d`` command on the specified tag removing it and its
1742 reflog (if it has one).
1744 The ``--clear`` option clears all but the most recent (the ``@{0}``)
1745 reflog entries from the reflog for the specified tag. It's equivalent
1746 to dropping all the higher numbered reflog entries.
1748 The ``--drop`` option drops the specified reflog entry and requires the
1749 given tagname to have an ``@{n}`` suffix where ``n`` is the reflog
1750 entry number to be dropped. This is really just a convenience option
1751 that runs the appropriate ``git reflog delete`` command.
1753 Note that when combined with ``tg revert``, a tag created by ``tg tag``
1754 can be used to transfer TopGit branches. Simply create the tag, push
1755 it somewhere and then have the recipient run ``tg revert`` to recreate
1756 the TopGit branches. This may be helpful in situations where it's not
1757 feasible to push all the refs corresponding to the TopGit-controlled
1758 branches and their top-bases.
1762 Provides a ``git rebase`` rerere auto continue function. It may be
1763 used as a drop-in replacement front-end for ``git rebase -m`` that
1764 automatically continues the rebase when ``git rerere`` information is
1765 sufficient to resolve all conflicts.
1767 You have enabled ``git rerere`` haven't you?
1769 If the ``-m`` or ``--merge`` option is not present then ``tg rebase``
1770 will complain and not do anything.
1772 When ``git rerere`` is enabled, previously resolved conflicts are
1773 remembered and can be automatically staged (see ``rerere.autoUpdate``).
1775 However, even with auto staging, ``git rebase`` still stops and
1776 requires an explicit ``git rebase --continue`` to keep going.
1778 In the case where ``git rebase -m`` is being used to flatten history
1779 (such as after a ``tg export --collapse`` prior to a
1780 ``git format-patch``), there's a good chance all conflicts have already
1781 been resolved during normal merge maintenance operations so there's no
1782 reason ``git rebase`` could not automatically continue, but there's no
1783 option to make it do so.
1785 The ``tg rebase`` command provides a ``git rebase --auto-continue``
1788 All the same rebase options can be used (they are simply passed through
1789 to Git unchanged). However, the ``rerere.autoUpdate`` option is
1790 automatically temporarily enabled while running ``git rebase`` and
1791 should ``git rebase`` stop asking one to resolve and continue, but all
1792 conflicts have already been resolved and staged using rerere
1793 information, then ``git rebase --continue`` will be automatically run.
1797 Provides the ability to revert one or more TopGit branches and their
1798 dependencies to a previous state contained within a tag created using
1799 the ``tg tag`` command. In addition to the actual revert mode
1800 operation a list mode operation is also provided to examine a tag's ref
1803 The default mode (``-l`` or ``--list``) shows the state of one or more
1804 of the refs/branches stored in the tag data. When no refs are given on
1805 the command line, all refs in the tag data are shown. With the special
1806 ref name ``--heads`` then the indepedent heads contained in the tag
1807 data are shown. The ``--deps`` option shows the specified refs and all
1808 of their dependencies in a single list with no duplicates. The
1809 ``--rdeps`` option shows a display similar to ``tg summary --rdeps``
1810 for each ref or all TopGit heads if no ref is given on the command
1811 line. The standard ``--no-short``, ``--short=n`` etc. options may be
1812 used to override the default ``--short`` output. With ``--hash`` (or
1813 ``--hash-only``) show only the hash in ``--list`` mode in which case
1814 the default is ``--no-short``. The ``--hash`` option can be used much
1815 like the ``git rev-parse --verify`` command to extract a specific hash
1816 value out of a TopGit tag.
1818 Note that unlike `tg summary`_, here ``--heads`` actually does mean the
1819 ``git merge-base --independent`` heads of the stored refs from the tag
1820 data. To see only the independent TopGit topic branch heads stored in
1821 the tag data use the ``--topgit-heads`` option instead. The default
1822 for the ``--rdeps`` option is ``--topgit-heads`` but ``--heads`` can
1823 be given explicitly to change that. (Note that ``--heads-independent``
1824 is accepted as an alias for ``--heads`` as well.)
1826 The revert mode has three submodes, dry-run mode (``-n`` or
1827 ``--dry-run``), force mode (``-f`` or ``--force``) and interactive mode
1828 (``-i`` or ``--interactive``). If ``--dry-run`` (or ``-n``) is given
1829 no ref updates will actually be performed but what would have been
1830 updated is shown instead. If ``--interactive`` (or ``-i``) is given
1831 then the editor is invoked on an instruction sheet allowing manual
1832 selection of the refs to be updated before proceeding. Since revert is
1833 potentially a destructive operation, at least one of the submodes must
1834 be specified explicitly. If no refs are listed on the command line
1835 then all refs in the tag data are reverted. Otherwise the listed refs
1836 and all of their dependencies (unless ``--no-deps`` is given) are
1837 reverted. Unless ``--no-stash`` is given a new stash will be created
1838 using ``tg tag --stash`` (except, of course, in dry-run mode) just
1839 before actually performing the updates to facilitate recovery from
1842 Both modes accept fully-qualified (i.e. starts with ``refs/``) ref
1843 names as well as unqualified names (which will be assumed to be located
1844 under ``refs/heads/``). In revert mode a tgish ref will always have
1845 both its ``refs/heads/`` and ``refs/top-bases/`` values included no
1846 matter how it's listed unless ``--no-deps`` is given and the ref is
1847 fully qualified (i.e. starts with ``refs/``) or one or the other of its
1848 values was removed from the instruction sheet in interactive mode. In
1849 list mode a tgish ref will always have both its ``refs/heads/`` and
1850 ``refs/top-bases/`` values included only when using the ``--deps`` or
1851 ``--rdeps`` options.
1853 The ``--tgish-only`` option excludes non-tgish refs (i.e. refs that do
1854 not have a ``refs/heads/<name>``, ``refs/top-bases/<name>`` pair).
1856 The ``--exclude`` option (which can be repeated) excludes specific
1857 refs. If the name given to ``--exclude`` is not fully-qualified (i.e.
1858 starts with ``refs/``) then it will exclude both members of a tgish ref
1861 The ``--quiet`` (or ``-q``) option may be used in revert mode to
1862 suppress non-dry-run ref change status messages.
1864 The special tag name ``--stash`` (as well as with ``@{n}`` suffixes)
1865 can be used to refer to ``refs/tgstash``.
1867 The ``tg revert`` command supports tags of tags that contains TopGit
1868 refs. So, for example, if you do this::
1871 git tag -f -a -m "tag the tag" newtag newtag
1873 Then ``newtag`` will be a tag of a tag containing a ``TOPGIT REFS``
1874 section. ``tg revert`` knows how to dereference the outermost
1875 tag to get to the next (and the next etc.) tag to find the
1876 ``TOPGIT REFS`` section so after the above sequence, the tag ``newtag``
1877 can still be used successfully with ``tg revert``.
1879 NOTE: If HEAD points to a ref that is updated by a revert operation
1880 then NO WARNING whatsoever will be issued, but the index and working
1881 tree will always be left completely untouched (and the reflog for
1882 the pointed-to ref can always be used to find the previous value).
1886 Output the "previous" branch(es) in the patch series containing the
1887 current or named branch. The "previous" branch(es) being one step
1891 -i show dependencies based on index instead of branch
1892 -w show dependencies based on working tree instead of branch
1893 -n <steps> take ``<steps>`` "previous" steps (default 1)
1894 --all take as many "previous" steps as possible (aka ``-a``)
1895 --verbose show containing series name(s) (aka ``-v``)
1897 The ``-n`` option may also be given as ``--count`` or ``--count=<n>``.
1899 To list all dependencies of a branch see the ``--deps`` option of
1900 the `tg info`_ command.
1902 See also NAVIGATION_ for full details on "previous" steps.
1906 Output tne "next" branch(es) in the patch series containing the current
1907 or named branch. The "next" branch(es) being one step away by default.
1910 -i show dependencies based on index instead of branch
1911 -w show dependencies based on working tree instead of branch
1912 -n <steps> take ``<steps>`` "next" steps (default 1)
1913 --all take as many "next" steps as possible (aka ``-a``)
1914 --verbose show containing series name(s) (aka ``-v``)
1916 The ``-n`` option may also be given as ``--count`` or ``--count=<n>``.
1918 To list all dependents of a branch see the ``--dependents`` option of
1919 the `tg info`_ command.
1921 See also NAVIGATION_ for full details on "next" steps.
1925 Transition top-bases from old location to new location.
1927 Beginning with TopGit release 0.19.4, TopGit has the ability to store
1928 the top-bases refs in either the old ``ref/top-bases/...`` location or
1929 the new ``refs/heads/{top-bases}/...`` location. Starting with TopGit
1930 release 0.20.0, the default is the new location.
1932 By storing the top-bases under heads, Git is less likely to complain
1933 when manipulating them, hosting providers are more likely to provide
1934 access to them and Git prevents them from pointing at anything other
1935 than a commit object. All in all a win for everyone.
1937 TopGit attempts to automatically detect whether the new or old location
1938 is being used for the top-bases and just do the right thing. However,
1939 by explicitly setting the config value ``topgit.top-bases`` to either
1940 ``refs`` for the old location or ``heads`` for the new location the
1941 auto-detection can be bypassed. If no top-bases refs are present in
1942 the repository the default prior to TopGit release 0.20.0 is to use the
1943 old location but starting with TopGit release 0.20.0 the default is to
1944 use the new location.
1946 The ``tg migrate-bases`` command may be used to migrate top-bases refs
1947 from the old location to the new location (or, by using the
1948 undocumented ``--reverse`` option, vice versa).
1950 With few exceptions (``tg create -r`` and ``tg revert``), all top-bases
1951 refs (both local *and* remote refs) are expected to be stored in the
1952 same location (either new or old). A repository's current location for
1953 storing top-bases refs may be shown with the ``tg --top-bases`` command.
1961 TopGit stores all the topic branches in the regular ``refs/heads/``
1962 namespace (so we recommend distinguishing them with the ``t/`` prefix).
1963 Apart from that, TopGit also maintains a set of auxiliary refs in
1964 ``refs/top-*``. Currently, only ``refs/top-bases/`` is used, containing the
1965 current *base* of the given topic branch -- this is basically a merge of
1966 all the branches the topic branch depends on; it is updated during ``tg
1967 update`` and then merged to the topic branch, and it is the base of a
1968 patch generated from the topic branch by ``tg patch``.
1970 All the metadata is tracked within the source tree and history of the
1971 topic branch itself, in ``.top*`` files; these files are kept isolated
1972 within the topic branches during TopGit-controlled merges and are of
1973 course omitted during ``tg patch``. The state of these files in base
1974 commits is undefined; look at them only in the topic branches
1975 themselves. Currently, two files are defined:
1978 Contains the description of the topic branch in a
1979 mail-like format, plus the author information, whatever
1980 Cc headers you choose or the post-three-dashes message.
1981 When mailing out your patch, basically only a few extra
1982 mail headers are inserted and then the patch itself is
1983 appended. Thus, as your patches evolve, you can record
1984 nuances like whether the particular patch should have
1985 To-list / Cc-maintainer or vice-versa and similar
1986 nuances, if your project is into that. ``From`` is
1987 prefilled from your current ``GIT_AUTHOR_IDENT``; other
1988 headers can be prefilled from various optional
1989 ``topgit.*`` git config options.
1992 Contains the one-per-line list of branches this branch
1993 depends on, pre-seeded by ``tg create``. A (continuously
1994 updated) merge of these branches will be the *base* of
1997 IMPORTANT: DO NOT EDIT ``.topdeps`` MANUALLY!!! If you do so, you need to
1998 know exactly what you are doing, since this file must stay in sync with
1999 the Git history information, otherwise very bad things will happen.
2001 TopGit also automagically installs a bunch of custom commit-related
2002 hooks that will verify whether you are committing the ``.top*`` files in a
2003 sane state. It will add the hooks to separate files within the ``hooks/``
2004 subdirectory, and merely insert calls to them to the appropriate hooks
2005 and make them executable (but will make sure the original hook's code is
2006 not called if the hook was not executable beforehand).
2008 Another automagically installed piece is a ``.git/info/attributes``
2009 specifier for an ``ours`` merge strategy for the files ``.topmsg`` and
2010 ``.topdeps``, and the (intuitive) ``ours`` merge strategy definition in
2017 There are two remaining issues with accessing topic branches in remote
2020 (i) Referring to remote topic branches from your local repository
2021 (ii) Developing some of the remote topic branches locally
2023 There are two somewhat contradictory design considerations here:
2025 (a) Hacking on multiple independent TopGit remotes in a single
2027 (b) Having a self-contained topic system in local refs space
2029 To us, (a) does not appear to be very convincing, while (b) is quite
2030 desirable for ``git-log topic`` etc. working, and increased conceptual
2033 Thus, we choose to instantiate all the topic branches of given remote
2034 locally; this is performed by ``tg remote --populate``. ``tg update``
2035 will also check if a branch can be updated from its corresponding remote
2036 branch. The logic needs to be somewhat involved if we are to "do the
2037 right thing". First, we update the base, handling the remote branch as
2038 if it was the first dependency; thus, conflict resolutions made in the
2039 remote branch will be carried over to our local base automagically.
2040 Then, the base is merged into the remote branch and the result is merged
2041 to the local branch -- again, to carry over remote conflict resolutions.
2042 In the future, this order might be adjustable on a per-update basis, in
2043 case local changes happen to be diverging more than the remote ones.
2044 (See the details in `The Update Process`_ for more in depth coverage.)
2046 All commands by default refer to the remote that ``tg remote --populate``
2047 was called on the last time (stored in the ``topgit.remote`` git
2048 configuration variable). You can manually run any command with a
2049 different base remote by passing ``-r REMOTE`` *before* the subcommand
2050 name or passing ``-u`` *before* the subcommand to run without one.
2056 A familiarity with the terms in the GLOSSARY_ is helpful for understanding the
2057 content of this sections. See also the IMPLEMENTATION_ section.
2062 When a branch is "updated" using the ``tg update`` command the following steps
2065 1) The branch and all of its dependencies (and theirs recursively)
2066 are checked to see which ones are *out-of-date*. See glossary_.
2068 2) Each of the branch's direct dependencies (i.e. they are listed in
2069 the branch's ``.topdeps`` file) which is out of date is updated
2070 before proceeding (yup, this is a recursive process).
2072 3) Each of the branch's direct dependencies (i.e. they are listed in
2073 the branch's ``.topdes`` file) that was updated in the previous
2074 step is now merged into the branch's corresponding base. If a
2075 remote is involved, and the branch's corresponding base does NOT
2076 contain the remote branch's corresponding base that remote base is
2077 also merged into the branch's base at this time as well (it will be
2078 the first item merged into the branch's base).
2080 4) If the branch has a corresponding remote branch and the branch
2081 does not already contain it, it's merged into the branch's base
2082 (which was possibly already updated in step (3) to contain the
2083 remote branch's base but not the remote branch itself) on a detached
2084 HEAD. Yup, this step can be a bit confusing and no, the updated
2085 base from step (3) has not yet been merged into the branch itself
2086 yet either. If there is no remote branch this step does not apply.
2087 Using a detached HEAD allows the remote branch to be merged into the
2088 contents of the base without actually perturbing the base's ref.
2090 5) If there is a remote branch present then use the result of step (4)
2091 otherwise use the branch's base and merge that into the branch
2094 That's it! Simple, right? ;)
2096 Unless the auto stash option has been disabled (see `no undo`_, `tg update`_
2097 and `tg tag`_), a copy of all the old refs values will be stashed away
2098 immediately after step (1) before starting step (2), but only if anything is
2099 actually found to be out-of-date.
2104 The ``tg update`` command regularly performs merges while executing an update
2105 operation. In order to speed things up, it attempts to do in-index merges
2106 where possible. It accomplishes this by using a separate, temporary index
2107 file and the ``git read-tree -m --aggressive`` command possibly assisted by
2108 the ``git merge-index`` and ``git merge-file`` commands. This combination may
2109 be repeated more than once to perform an octopus in-index merge. If this
2110 fails, the files are checked out and a normal ``git merge`` three-way merge is
2111 performed (possily multiple times). If the normal ``git merge`` fails then
2112 user intervention is required to resolve the merge conflict(s) and continue.
2114 Since the ``tg annihilate``, ``tg create`` and ``tg depend add`` commands may
2115 end up running the ``tg update`` machinery behind the scenes to complete their
2116 operation they may also result in any of these merge strategies being used.
2118 In addition to the normal Git merge strategies (if the in-index merging fails),
2119 there are four possible TopGit merge strategies that may be shown. Since they
2120 all involve use of the ``git read-tree -m --aggressive`` command they are all
2121 variations of a "trivial aggressive" merge. The "trivial" part because all of
2122 the merges done by ``git read-tree -m`` are described as "trivial" and the
2123 "aggressive" part because the ``--aggressive`` option is always used.
2125 1) "trivial aggressive"
2126 Only two heads were involved and all merging was completed by
2127 the ``git read-tree -m --aggressive`` command.
2129 2) "trivial aggressive automatic"
2130 Only two heads were involved but after the
2131 ``git read-tree -m --aggressive`` command completed there were
2132 still unresolved items and ``git merge-index`` had to be run
2133 (using the ``tg index-merge-one-file`` driver) which ultimately
2134 ran ``git merge-file`` at least once to perform a simple
2135 automatic three-way merge. Hence the "automatic" description
2136 and the "Auto-merging ..." output line(s).
2138 3) "trivial aggressive octopus"
2139 This is the same as a "trivial aggressive" merge except that
2140 more than two heads were involved and after merging the first
2141 two heads, the ``git read-tree -m --aggressive`` step was
2142 repeated again on the result for each additional head. All
2143 merging was completed via multiple
2144 ``git read-tree -m --aggressive`` commands only.
2145 This beast is relatively rare in the wild.
2147 4) "trivial aggressive automatic octopus"
2148 This is very similar to the "trivial aggressive octopus"
2149 except that at least one of the ``git read-tree -m --aggressive``
2150 commands left unresolved items that were handled the same way
2151 as the "trivial aggressive automatic" strategy. This species
2152 is commonly seen in the wild.
2159 Version-controlled file stored at the root level of each
2160 TopGit branch that contains the patch header for a TopGit
2161 branch. See also IMPLEMENTATION_;
2164 Version-controlled file stored at the root level of each
2165 TopGit branch that lists the branch's dependencies one per
2166 line omitting the leading ``refs/heads/`` part. See also
2170 Given two Git commit identifiers (e.g. hashes) C1 and C2,
2171 commit C1 "contains" commit C2 if either they are the same
2172 commit or C2 can be reached from C1 by following one or more
2173 parent links from C1 (perhaps via one or more intermediate
2174 commits along the way). In other words, if C1 contains C2
2175 then C2 is an ancestor of C1 or conversely C1 is a descendant
2176 of C2. Since a TopGit branch name is also the name of a Git
2177 branch (something located under the ``refs/heads`` Git
2178 namespace) and similarly for a TopGit base, they can both be
2179 resolved to a Git commit identifier and then participate in
2180 a branch containment test. An easy mnemonic for this is
2181 "children contain the genes of their parents."
2184 A Basic Regular Expression (BRE) pattern. These are older
2185 style regular expressions but have the advantage that all
2186 characters other than ``\``, ``.``, ``*`` and ``[``
2187 automatically match themselves without need for backslash
2188 quoting (well actually, ``^`` and ``$`` are special at the
2189 beginning and end respectively but otherwise match themselves).
2192 See branch containment.
2195 An Extended Regular Expression (ERE) pattern. These are newer
2196 style regular expressions where all the regular expression
2197 "operator" characters "operate" when NOT preceded by a
2198 backslash and are turned into normal characters with a ``\``.
2199 The backreference atom, however, may not work, but ``?``, ``+``
2200 and ``|`` "operators" do; unlike BREs.
2203 Excellent system for managing a history of changes to one
2204 or more possibly interrelated patches.
2207 A Git branch that has an associated TopGit base. Conceptually
2208 it represents a single patch that is the difference between
2209 the associated TopGit base and the TopGit branch. In other
2210 words ``git diff-tree <TopGit base> <TopGit branch>`` except
2211 that any ``.topdeps`` and/or ``.topmsg`` files are excluded
2212 from the result and the contents of the ``.topmsg`` file from
2213 the TopGit branch is prefixed to the result.
2216 A Git branch that records the base upon which a TopGit branch's
2217 single conceptual "patch" is built. The name of the Git branch
2218 is derived from the TopGit branch name by stripping off the
2219 leading ``refs/heads/`` and appending the correct prefix where
2220 all TopGit bases are stored (typically either
2221 ``refs/top-bases/`` or ``refs/heads/{top-bases}/`` -- the
2222 prefix for any given repository can be shown by using the
2223 ``tg --top-bases`` command and updated using the
2224 ``tg migrate-bases`` command).
2226 All of a TopGit branch's dependencies are merged into the
2227 corresponding TopGit base during a ``tg update`` of a branch.
2232 TopGit ``[PATCH]`` branch
2233 A TopGit branch whose subject starts with ``[PATCH]``. By
2234 convention these TopGit branches contain a single patch
2235 (equivalent to a single patch file) and have at least one
2236 dependency (i.e. their ``.topdeps`` files are never empty).
2238 TopGit ``[BASE]`` branch
2239 A TopGit branch whose subject starts with ``[BASE]``. By
2240 convention these TopGit branches do not actually contain
2241 any changes and their ``.topdeps`` files are empty. They
2242 are used to control a base dependency that another set of
2243 branches depends on.
2245 TopGit ``[STAGE]`` branch
2246 A TopGit branch whose subject starts with ``[STAGE]``. By
2247 convention these TopGit branches do not actually contain any
2248 changes of their own but do have one or (typically) more
2249 dependencies in their ``.topdeps`` file. These branches are
2250 used to bring together one or (typically) more independent
2251 TopGit ``[PATCH]`` branches into a single branch so that
2252 testing and/or evaluation can be performed on the result.
2255 When merging two (or more) heads that touch the same lines in
2256 the file but in different ways the result is a merge conflict
2257 that requires manual intervention. If a merge conflict occurs
2258 with more than two heads (an octopus merge) it's generally
2259 replaced by multiple three-way merges so that by the time a
2260 user sees a merge conflict needing manual resolution, there
2261 will be only two heads involved.
2264 A Git merge strategy (see the "MERGE STRATEGIES" section of
2265 ``git help merge``) or one of the TopGit `merge strategies`_
2266 used to merge two or more heads.
2268 TopGit merge strategy
2269 See the `Merge Strategies`_ section above for details but
2270 basically these are just in-index merges done using the
2271 ``git read-tree -m --aggressive`` command one or more times
2272 possibily assisted by the ``git merge-index`` and the
2273 ``git merge-file`` commands.
2276 In TopGit context the "next" branch refers to the branch that
2277 corresponds to the next (aka following) patch in an ordered
2278 (aka linearized) list of patches created by exporting the
2279 TopGit branches in patch application order.
2282 A merge involving more than two heads. Note that if there are
2283 less than three independent heads the resulting merge that
2284 started out as an octopus will end up not actually being an
2288 A TopGit branch is considered to be "out-of-date" when ANY of
2289 the following are true:
2291 a) The TopGit branch does NOT contain its
2294 b) The TopGit branch does NOT contain its
2295 corresponding remote branch (there may not be
2296 a remote branch in which case this does not apply)
2298 c) The TopGit branch's base does NOT contain its
2299 corresponding remote branch's base (there may not be
2300 a remote branch in which case this does not apply)
2302 d) Any of the TopGit branches listed in the branch's
2303 ``.topdeps`` file are NOT contained by the branch.
2304 (See "branch containment" above.)
2306 e) Any of the TopGit branches listed in the branch's
2307 ``.topdeps`` file are out-of-date.
2309 Note that if a remote branch is present and is NOT out-of-date
2310 then it will contain its own base and (c) is mostly redundant.
2313 In TopGit context the "previous" (or "prev") branch refers to
2314 the branch that corresponds to the previous (aka preceding)
2315 patch in an ordered (aka linearized) list of patches created by
2316 exporting the TopGit branches in patch application order.
2318 remote TopGit branch
2319 A Git branch with the same branch name as a TopGit branch
2320 but living under ``refs/remotes/<some remote>/`` instead
2321 of just ``refs/heads/``.
2324 The TopGit base branch corresponding to a remote TopGit branch,
2325 which lives under ``refs/remotes/`` somewhere (depending on
2326 what the output of ``tg --top-bases`` is for that remote).
2329 A three-way merge takes a common base and two heads (call them
2330 A and B) and creates a new file that is the common base plus
2331 all of the changes made between the common base and head A
2332 *AND* all of the changes made between the common base and
2333 head B. The technique used to accomplish this is called a
2340 The following references are useful to understand the development of
2341 topgit and its subcommands.
2344 http://public-inbox.org/git/36ca99e90904091034m4d4d31dct78acb333612e678@mail.gmail.com/T/#u
2347 THIRD-PARTY SOFTWARE
2348 --------------------
2350 The following software understands TopGit branches:
2352 * `magit <http://magit.github.io/>`_ -- a git mode for emacs
2354 IMPORTANT: Magit requires its topgit mode to be enabled first, as
2355 described in its documentation, in the "Activating extensions"
2356 subsection. If this is not done, it will not push TopGit branches
2357 correctly, so it's important to enable it even if you plan to mostly use
2358 TopGit from the command line.