Updated git_doc to git 1.8

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / gitworkflows.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
\r
<sect2 lang="en" id="gitworkflows(7)">\r
    <title>gitworkflows(7)</title>\r
<indexterm>\r
<primary>gitworkflows(7)</primary>\r
</indexterm>\r
<simplesect id="gitworkflows(7)__name">\r
<title>NAME</title>\r
<simpara>gitworkflows - An overview of recommended workflows with git</simpara>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout>git *</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__description">\r
<title>DESCRIPTION</title>\r
<simpara>This document attempts to write down and motivate some of the workflow\r
elements used for <emphasis>git.git</emphasis> itself.  Many ideas apply in general,\r
though the full workflow is rarely required for smaller projects with\r
fewer people involved.</simpara>\r
<simpara>We formulate a set of <emphasis>rules</emphasis> for quick reference, while the prose\r
tries to motivate each of them.  Do not always take them literally;\r
you should value good reasons for your actions higher than manpages\r
such as this one.</simpara>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__separate_changes">\r
<title>SEPARATE CHANGES</title>\r
<simpara>As a general rule, you should try to split your changes into small\r
logical steps, and commit each of them.  They should be consistent,\r
working independently of any later commits, pass the test suite, etc.\r
This makes the review process much easier, and the history much more\r
useful for later inspection and analysis, for example with\r
<xref linkend="git-blame(1)" /> and <xref linkend="git-bisect(1)" />.</simpara>\r
<simpara>To achieve this, try to split your work into small steps from the very\r
beginning. It is always easier to squash a few commits together than\r
to split one big commit into several.  Don't be afraid of making too\r
small or imperfect steps along the way. You can always go back later\r
and edit the commits with <emphasis>git rebase --interactive</emphasis> before you\r
publish them.  You can use <emphasis>git stash save --keep-index</emphasis> to run the\r
test suite independent of other uncommitted changes; see the EXAMPLES\r
section of <xref linkend="git-stash(1)" />.</simpara>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__managing_branches">\r
<title>MANAGING BRANCHES</title>\r
<simpara>There are two main tools that can be used to include changes from one\r
branch on another: <xref linkend="git-merge(1)" /> and\r
<xref linkend="git-cherry-pick(1)" />.</simpara>\r
<simpara>Merges have many advantages, so we try to solve as many problems as\r
possible with merges alone.  Cherry-picking is still occasionally\r
useful; see "Merging upwards" below for an example.</simpara>\r
<simpara>Most importantly, merging works at the branch level, while\r
cherry-picking works at the commit level.  This means that a merge can\r
carry over the changes from 1, 10, or 1000 commits with equal ease,\r
which in turn means the workflow scales much better to a large number\r
of contributors (and contributions).  Merges are also easier to\r
understand because a merge commit is a "promise" that all changes from\r
all its parents are now included.</simpara>\r
<simpara>There is a tradeoff of course: merges require a more careful branch\r
management.  The following subsections discuss the important points.</simpara>\r
<section id="gitworkflows(7)__graduation">\r
<title>Graduation</title>\r
<simpara>As a given feature goes from experimental to stable, it also\r
"graduates" between the corresponding branches of the software.\r
<emphasis>git.git</emphasis> uses the following <emphasis>integration branches</emphasis>:</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>maint</emphasis> tracks the commits that should go into the next "maintenance\r
  release", i.e., update of the last released stable version;\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>master</emphasis> tracks the commits that should go into the next release;\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>next</emphasis> is intended as a testing branch for topics being tested for\r
  stability for master.\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>There is a fourth official branch that is used slightly differently:</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>pu</emphasis> (proposed updates) is an integration branch for things that are\r
  not quite ready for inclusion yet (see "Integration Branches"\r
  below).\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>Each of the four branches is usually a direct descendant of the one\r
above it.</simpara>\r
<simpara>Conceptually, the feature enters at an unstable branch (usually <emphasis>next</emphasis>\r
or <emphasis>pu</emphasis>), and "graduates" to <emphasis>master</emphasis> for the next release once it is\r
considered stable enough.</simpara>\r
</section>\r
<section id="gitworkflows(7)__merging_upwards">\r
<title>Merging upwards</title>\r
<simpara>The "downwards graduation" discussed above cannot be done by actually\r
merging downwards, however, since that would merge <emphasis>all</emphasis> changes on\r
the unstable branch into the stable one.  Hence the following:</simpara>\r
<example>\r
<title>Merge upwards</title>\r
<simpara>Always commit your fixes to the oldest supported branch that require\r
them.  Then (periodically) merge the integration branches upwards into each\r
other.</simpara>\r
</example>\r
<simpara>This gives a very controlled flow of fixes.  If you notice that you\r
have applied a fix to e.g. <emphasis>master</emphasis> that is also required in <emphasis>maint</emphasis>,\r
you will need to cherry-pick it (using <xref linkend="git-cherry-pick(1)" />)\r
downwards.  This will happen a few times and is nothing to worry about\r
unless you do it very frequently.</simpara>\r
</section>\r
<section id="gitworkflows(7)__topic_branches">\r
<title>Topic branches</title>\r
<simpara>Any nontrivial feature will require several patches to implement, and\r
may get extra bugfixes or improvements during its lifetime.</simpara>\r
<simpara>Committing everything directly on the integration branches leads to many\r
problems: Bad commits cannot be undone, so they must be reverted one\r
by one, which creates confusing histories and further error potential\r
when you forget to revert part of a group of changes.  Working in\r
parallel mixes up the changes, creating further confusion.</simpara>\r
<simpara>Use of "topic branches" solves these problems.  The name is pretty\r
self explanatory, with a caveat that comes from the "merge upwards"\r
rule above:</simpara>\r
<example>\r
<title>Topic branches</title>\r
<simpara>Make a side branch for every topic (feature, bugfix, &#8230;). Fork it off\r
at the oldest integration branch that you will eventually want to merge it\r
into.</simpara>\r
</example>\r
<simpara>Many things can then be done very naturally:</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
To get the feature/bugfix into an integration branch, simply merge\r
  it.  If the topic has evolved further in the meantime, merge again.\r
  (Note that you do not necessarily have to merge it to the oldest\r
  integration branch first.  For example, you can first merge a bugfix\r
  to <emphasis>next</emphasis>, give it some testing time, and merge to <emphasis>maint</emphasis> when you\r
  know it is stable.)\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
If you find you need new features from the branch <emphasis>other</emphasis> to continue\r
  working on your topic, merge <emphasis>other</emphasis> to <emphasis>topic</emphasis>.  (However, do not\r
  do this "just habitually", see below.)\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
If you find you forked off the wrong branch and want to move it\r
  "back in time", use <xref linkend="git-rebase(1)" />.\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>Note that the last point clashes with the other two: a topic that has\r
been merged elsewhere should not be rebased.  See the section on\r
RECOVERING FROM UPSTREAM REBASE in <xref linkend="git-rebase(1)" />.</simpara>\r
<simpara>We should point out that "habitually" (regularly for no real reason)\r
merging an integration branch into your topics -- and by extension,\r
merging anything upstream into anything downstream on a regular basis\r
-- is frowned upon:</simpara>\r
<example>\r
<title>Merge to downstream only at well-defined points</title>\r
<simpara>Do not merge to downstream except with a good reason: upstream API\r
changes affect your branch; your branch no longer merges to upstream\r
cleanly; etc.</simpara>\r
</example>\r
<simpara>Otherwise, the topic that was merged to suddenly contains more than a\r
single (well-separated) change.  The many resulting small merges will\r
greatly clutter up history.  Anyone who later investigates the history\r
of a file will have to find out whether that merge affected the topic\r
in development.  An upstream might even inadvertently be merged into a\r
"more stable" branch.  And so on.</simpara>\r
</section>\r
<section id="gitworkflows(7)__throw_away_integration">\r
<title>Throw-away integration</title>\r
<simpara>If you followed the last paragraph, you will now have many small topic\r
branches, and occasionally wonder how they interact.  Perhaps the\r
result of merging them does not even work?  But on the other hand, we\r
want to avoid merging them anywhere "stable" because such merges\r
cannot easily be undone.</simpara>\r
<simpara>The solution, of course, is to make a merge that we can undo: merge\r
into a throw-away branch.</simpara>\r
<example>\r
<title>Throw-away integration branches</title>\r
<simpara>To test the interaction of several topics, merge them into a\r
throw-away branch.  You must never base any work on such a branch!</simpara>\r
</example>\r
<simpara>If you make it (very) clear that this branch is going to be deleted\r
right after the testing, you can even publish this branch, for example\r
to give the testers a chance to work with it, or other developers a\r
chance to see if their in-progress work will be compatible.  <emphasis>git.git</emphasis>\r
has such an official throw-away integration branch called <emphasis>pu</emphasis>.</simpara>\r
</section>\r
<section id="gitworkflows(7)__branch_management_for_a_release">\r
<title>Branch management for a release</title>\r
<simpara>Assuming you are using the merge approach discussed above, when you\r
are releasing your project you will need to do some additional branch\r
management work.</simpara>\r
<simpara>A feature release is created from the <emphasis>master</emphasis> branch, since <emphasis>master</emphasis>\r
tracks the commits that should go into the next feature release.</simpara>\r
<simpara>The <emphasis>master</emphasis> branch is supposed to be a superset of <emphasis>maint</emphasis>. If this\r
condition does not hold, then <emphasis>maint</emphasis> contains some commits that\r
are not included on <emphasis>master</emphasis>. The fixes represented by those commits\r
will therefore not be included in your feature release.</simpara>\r
<simpara>To verify that <emphasis>master</emphasis> is indeed a superset of <emphasis>maint</emphasis>, use git log:</simpara>\r
<example>\r
<title>Verify <emphasis>master</emphasis> is a superset of <emphasis>maint</emphasis></title>\r
<simpara><emphasis>git log master..maint</emphasis></simpara>\r
</example>\r
<simpara>This command should not list any commits.  Otherwise, check out\r
<emphasis>master</emphasis> and merge <emphasis>maint</emphasis> into it.</simpara>\r
<simpara>Now you can proceed with the creation of the feature release. Apply a\r
tag to the tip of <emphasis>master</emphasis> indicating the release version:</simpara>\r
<example>\r
<title>Release tagging</title>\r
<simpara><emphasis>git tag -s -m "GIT X.Y.Z" vX.Y.Z master</emphasis></simpara>\r
</example>\r
<simpara>You need to push the new tag to a public git server (see\r
"DISTRIBUTED WORKFLOWS" below). This makes the tag available to\r
others tracking your project. The push could also trigger a\r
post-update hook to perform release-related items such as building\r
release tarballs and preformatted documentation pages.</simpara>\r
<simpara>Similarly, for a maintenance release, <emphasis>maint</emphasis> is tracking the commits\r
to be released. Therefore, in the steps above simply tag and push\r
<emphasis>maint</emphasis> rather than <emphasis>master</emphasis>.</simpara>\r
</section>\r
<section id="gitworkflows(7)__maintenance_branch_management_after_a_feature_release">\r
<title>Maintenance branch management after a feature release</title>\r
<simpara>After a feature release, you need to manage your maintenance branches.</simpara>\r
<simpara>First, if you wish to continue to release maintenance fixes for the\r
feature release made before the recent one, then you must create\r
another branch to track commits for that previous release.</simpara>\r
<simpara>To do this, the current maintenance branch is copied to another branch\r
named with the previous release version number (e.g. maint-X.Y.(Z-1)\r
where X.Y.Z is the current release).</simpara>\r
<example>\r
<title>Copy maint</title>\r
<simpara><emphasis>git branch maint-X.Y.(Z-1) maint</emphasis></simpara>\r
</example>\r
<simpara>The <emphasis>maint</emphasis> branch should now be fast-forwarded to the newly released\r
code so that maintenance fixes can be tracked for the current release:</simpara>\r
<example>\r
<title>Update maint to new release</title>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>git checkout maint</emphasis>\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>git merge --ff-only master</emphasis>\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
</example>\r
<simpara>If the merge fails because it is not a fast-forward, then it is\r
possible some fixes on <emphasis>maint</emphasis> were missed in the feature release.\r
This will not happen if the content of the branches was verified as\r
described in the previous section.</simpara>\r
</section>\r
<section id="gitworkflows(7)__branch_management_for_next_and_pu_after_a_feature_release">\r
<title>Branch management for next and pu after a feature release</title>\r
<simpara>After a feature release, the integration branch <emphasis>next</emphasis> may optionally be\r
rewound and rebuilt from the tip of <emphasis>master</emphasis> using the surviving\r
topics on <emphasis>next</emphasis>:</simpara>\r
<example>\r
<title>Rewind and rebuild next</title>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>git checkout next</emphasis>\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>git reset --hard master</emphasis>\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>git merge ai/topic_in_next1</emphasis>\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>git merge ai/topic_in_next2</emphasis>\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
&#8230;\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
</example>\r
<simpara>The advantage of doing this is that the history of <emphasis>next</emphasis> will be\r
clean. For example, some topics merged into <emphasis>next</emphasis> may have initially\r
looked promising, but were later found to be undesirable or premature.\r
In such a case, the topic is reverted out of <emphasis>next</emphasis> but the fact\r
remains in the history that it was once merged and reverted. By\r
recreating <emphasis>next</emphasis>, you give another incarnation of such topics a clean\r
slate to retry, and a feature release is a good point in history to do\r
so.</simpara>\r
<simpara>If you do this, then you should make a public announcement indicating\r
that <emphasis>next</emphasis> was rewound and rebuilt.</simpara>\r
<simpara>The same rewind and rebuild process may be followed for <emphasis>pu</emphasis>. A public\r
announcement is not necessary since <emphasis>pu</emphasis> is a throw-away branch, as\r
described above.</simpara>\r
</section>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__distributed_workflows">\r
<title>DISTRIBUTED WORKFLOWS</title>\r
<simpara>After the last section, you should know how to manage topics.  In\r
general, you will not be the only person working on the project, so\r
you will have to share your work.</simpara>\r
<simpara>Roughly speaking, there are two important workflows: merge and patch.\r
The important difference is that the merge workflow can propagate full\r
history, including merges, while patches cannot.  Both workflows can\r
be used in parallel: in <emphasis>git.git</emphasis>, only subsystem maintainers use\r
the merge workflow, while everyone else sends patches.</simpara>\r
<simpara>Note that the maintainer(s) may impose restrictions, such as\r
"Signed-off-by" requirements, that all commits/patches submitted for\r
inclusion must adhere to.  Consult your project's documentation for\r
more information.</simpara>\r
<section id="gitworkflows(7)__merge_workflow">\r
<title>Merge workflow</title>\r
<simpara>The merge workflow works by copying branches between upstream and\r
downstream.  Upstream can merge contributions into the official\r
history; downstream base their work on the official history.</simpara>\r
<simpara>There are three main tools that can be used for this:</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<xref linkend="git-push(1)" /> copies your branches to a remote repository,\r
  usually to one that can be read by all involved parties;\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<xref linkend="git-fetch(1)" /> that copies remote branches to your repository;\r
  and\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<xref linkend="git-pull(1)" /> that does fetch and merge in one go.\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>Note the last point.  Do <emphasis>not</emphasis> use <emphasis>git pull</emphasis> unless you actually want\r
to merge the remote branch.</simpara>\r
<simpara>Getting changes out is easy:</simpara>\r
<example>\r
<title>Push/pull: Publishing branches/topics</title>\r
<simpara><emphasis>git push &lt;remote&gt; &lt;branch&gt;</emphasis> and tell everyone where they can fetch\r
from.</simpara>\r
</example>\r
<simpara>You will still have to tell people by other means, such as mail.  (Git\r
provides the <xref linkend="git-request-pull(1)" /> to send preformatted pull\r
requests to upstream maintainers to simplify this task.)</simpara>\r
<simpara>If you just want to get the newest copies of the integration branches,\r
staying up to date is easy too:</simpara>\r
<example>\r
<title>Push/pull: Staying up to date</title>\r
<simpara>Use <emphasis>git fetch &lt;remote&gt;</emphasis> or <emphasis>git remote update</emphasis> to stay up to date.</simpara>\r
</example>\r
<simpara>Then simply fork your topic branches from the stable remotes as\r
explained earlier.</simpara>\r
<simpara>If you are a maintainer and would like to merge other people's topic\r
branches to the integration branches, they will typically send a\r
request to do so by mail.  Such a request looks like</simpara>\r
<screen>Please pull from\r
    &lt;url&gt; &lt;branch&gt;</screen>\r
<simpara>In that case, <emphasis>git pull</emphasis> can do the fetch and merge in one go, as\r
follows.</simpara>\r
<example>\r
<title>Push/pull: Merging remote topics</title>\r
<simpara><emphasis>git pull &lt;url&gt; &lt;branch&gt;</emphasis></simpara>\r
</example>\r
<simpara>Occasionally, the maintainer may get merge conflicts when he tries to\r
pull changes from downstream.  In this case, he can ask downstream to\r
do the merge and resolve the conflicts themselves (perhaps they will\r
know better how to resolve them).  It is one of the rare cases where\r
downstream <emphasis>should</emphasis> merge from upstream.</simpara>\r
</section>\r
<section id="gitworkflows(7)__patch_workflow">\r
<title>Patch workflow</title>\r
<simpara>If you are a contributor that sends changes upstream in the form of\r
emails, you should use topic branches as usual (see above).  Then use\r
<xref linkend="git-format-patch(1)" /> to generate the corresponding emails\r
(highly recommended over manually formatting them because it makes the\r
maintainer's life easier).</simpara>\r
<example>\r
<title>format-patch/am: Publishing branches/topics</title>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>git format-patch -M upstream..topic</emphasis> to turn them into preformatted\r
  patch files\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>git send-email --to=&lt;recipient&gt; &lt;patches&gt;</emphasis>\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
</example>\r
<simpara>See the <xref linkend="git-format-patch(1)" /> and <xref linkend="git-send-email(1)" />\r
manpages for further usage notes.</simpara>\r
<simpara>If the maintainer tells you that your patch no longer applies to the\r
current upstream, you will have to rebase your topic (you cannot use a\r
merge because you cannot format-patch merges):</simpara>\r
<example>\r
<title>format-patch/am: Keeping topics up to date</title>\r
<simpara><emphasis>git pull --rebase &lt;url&gt; &lt;branch&gt;</emphasis></simpara>\r
</example>\r
<simpara>You can then fix the conflicts during the rebase.  Presumably you have\r
not published your topic other than by mail, so rebasing it is not a\r
problem.</simpara>\r
<simpara>If you receive such a patch series (as maintainer, or perhaps as a\r
reader of the mailing list it was sent to), save the mails to files,\r
create a new topic branch and use <emphasis>git am</emphasis> to import the commits:</simpara>\r
<example>\r
<title>format-patch/am: Importing patches</title>\r
<simpara><emphasis>git am &lt; patch</emphasis></simpara>\r
</example>\r
<simpara>One feature worth pointing out is the three-way merge, which can help\r
if you get conflicts: <emphasis>git am -3</emphasis> will use index information contained\r
in patches to figure out the merge base.  See <xref linkend="git-am(1)" /> for\r
other options.</simpara>\r
</section>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__see_also">\r
<title>SEE ALSO</title>\r
<simpara><xref linkend="gittutorial(7)" />,\r
<xref linkend="git-push(1)" />,\r
<xref linkend="git-pull(1)" />,\r
<xref linkend="git-merge(1)" />,\r
<xref linkend="git-rebase(1)" />,\r
<xref linkend="git-format-patch(1)" />,\r
<xref linkend="git-send-email(1)" />,\r
<xref linkend="git-am(1)" /></simpara>\r
</simplesect>\r
<simplesect id="gitworkflows(7)__git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)" /> suite.</simpara>\r
</simplesect>\r
</sect2>\r