<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Development workflow — NetworkX 1.8.1 documentation</title>
<link rel="stylesheet" href="../../_static/networkx.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.8.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within NetworkX 1.8.1 documentation"
href="../../_static/opensearch.xml"/>
<link rel="top" title="NetworkX 1.8.1 documentation" href="../../index.html" />
<link rel="up" title="Git for development" href="git_development.html" />
<link rel="next" title="Maintainer workflow" href="maintainer_workflow.html" />
<link rel="prev" title="Configure git" href="configure_git.html" />
</head>
<body>
<div style="color: black;background-color: white; font-size: 3.2em; text-align: left; padding: 15px 10px 10px 15px">
NetworkX
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="maintainer_workflow.html" title="Maintainer workflow"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="configure_git.html" title="Configure git"
accesskey="P">previous</a> |</li>
<li><a href="http://networkx.github.com/">NetworkX Home </a> | </li>
<li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li>
<li><a href="http://networkx.github.com/download.html">Download </a> | </li>
<li><a href="http://github.com/networkx">Developer (Github)</a></li>
<li><a href="../index.html" >Developer Guide</a> »</li>
<li><a href="index.html" >Working with <em>networkx</em> source code</a> »</li>
<li><a href="git_development.html" accesskey="U">Git for development</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Development workflow</a><ul>
<li><a class="reference internal" href="#workflow-summary">Workflow summary</a></li>
<li><a class="reference internal" href="#consider-deleting-your-master-branch">Consider deleting your master branch</a></li>
<li><a class="reference internal" href="#update-the-mirror-of-trunk">Update the mirror of trunk</a></li>
<li><a class="reference internal" href="#make-a-new-feature-branch">Make a new feature branch</a></li>
<li><a class="reference internal" href="#the-editing-workflow">The editing workflow</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#in-more-detail">In more detail</a></li>
</ul>
</li>
<li><a class="reference internal" href="#ask-for-your-changes-to-be-reviewed-or-merged">Ask for your changes to be reviewed or merged</a></li>
<li><a class="reference internal" href="#some-other-things-you-might-want-to-do">Some other things you might want to do</a><ul>
<li><a class="reference internal" href="#delete-a-branch-on-github">Delete a branch on github</a></li>
<li><a class="reference internal" href="#several-people-sharing-a-single-repository">Several people sharing a single repository</a></li>
<li><a class="reference internal" href="#explore-your-repository">Explore your repository</a></li>
<li><a class="reference internal" href="#rebasing-on-trunk">Rebasing on trunk</a></li>
<li><a class="reference internal" href="#recovering-from-mess-ups">Recovering from mess-ups</a></li>
<li><a class="reference internal" href="#rewriting-commit-history">Rewriting commit history</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="configure_git.html"
title="previous chapter">Configure git</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="maintainer_workflow.html"
title="next chapter">Maintainer workflow</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="development-workflow">
<span id="id1"></span><h1>Development workflow<a class="headerlink" href="#development-workflow" title="Permalink to this headline">¶</a></h1>
<p>You already have your own forked copy of the <a href="#id11"><span class="problematic" id="id12">`networkx`_</span></a> repository, by
following <a class="reference internal" href="forking_hell.html#forking"><em>Making your own copy (fork) of networkx</em></a>. You have <a class="reference internal" href="set_up_fork.html#set-up-fork"><em>Set up your fork</em></a>. You have configured
git by following <a class="reference internal" href="configure_git.html#configure-git"><em>Configure git</em></a>. Now you are ready for some real work.</p>
<div class="section" id="workflow-summary">
<h2>Workflow summary<a class="headerlink" href="#workflow-summary" title="Permalink to this headline">¶</a></h2>
<p>In what follows we’ll refer to the upstream networkx <tt class="docutils literal"><span class="pre">master</span></tt> branch, as
“trunk”.</p>
<ul class="simple">
<li>Don’t use your <tt class="docutils literal"><span class="pre">master</span></tt> branch for anything. Consider deleting it.</li>
<li>When you are starting a new set of changes, fetch any changes from trunk,
and start a new <em>feature branch</em> from that.</li>
<li>Make a new branch for each separable set of changes <a href="#id3"><span class="problematic" id="id4">|emdash|</span></a> “one task, one
branch” (<a href="#id13"><span class="problematic" id="id14">`ipython git workflow`_</span></a>).</li>
<li>Name your branch for the purpose of the changes - e.g.
<tt class="docutils literal"><span class="pre">bugfix-for-issue-14</span></tt> or <tt class="docutils literal"><span class="pre">refactor-database-code</span></tt>.</li>
<li>If you can possibly avoid it, avoid merging trunk or any other branches into
your feature branch while you are working.</li>
<li>If you do find yourself merging from trunk, consider <a class="reference internal" href="#rebase-on-trunk"><em>Rebasing on trunk</em></a></li>
<li>Ask on the <a href="#id15"><span class="problematic" id="id16">`networkx mailing list`_</span></a> if you get stuck.</li>
<li>Ask for code review!</li>
</ul>
<p>This way of working helps to keep work well organized, with readable history.
This in turn makes it easier for project maintainers (that might be you) to see
what you’ve done, and why you did it.</p>
<p>See <a href="#id17"><span class="problematic" id="id18">`linux git workflow`_</span></a> and <a href="#id19"><span class="problematic" id="id20">`ipython git workflow`_</span></a> for some explanation.</p>
</div>
<div class="section" id="consider-deleting-your-master-branch">
<h2>Consider deleting your master branch<a class="headerlink" href="#consider-deleting-your-master-branch" title="Permalink to this headline">¶</a></h2>
<p>It may sound strange, but deleting your own <tt class="docutils literal"><span class="pre">master</span></tt> branch can help reduce
confusion about which branch you are on. See <a href="#id21"><span class="problematic" id="id22">`deleting master on github`_</span></a> for
details.</p>
</div>
<div class="section" id="update-the-mirror-of-trunk">
<span id="update-mirror-trunk"></span><h2>Update the mirror of trunk<a class="headerlink" href="#update-the-mirror-of-trunk" title="Permalink to this headline">¶</a></h2>
<p>First make sure you have done <a class="reference internal" href="set_up_fork.html#linking-to-upstream"><em>Linking your repository to the upstream repo</em></a>.</p>
<p>From time to time you should fetch the upstream (trunk) changes from github:</p>
<div class="highlight-python"><pre>git fetch upstream</pre>
</div>
<p>This will pull down any commits you don’t have, and set the remote branches to
point to the right commit. For example, ‘trunk’ is the branch referred to by
(remote/branchname) <tt class="docutils literal"><span class="pre">upstream/master</span></tt> - and if there have been commits since
you last checked, <tt class="docutils literal"><span class="pre">upstream/master</span></tt> will change after you do the fetch.</p>
</div>
<div class="section" id="make-a-new-feature-branch">
<span id="make-feature-branch"></span><h2>Make a new feature branch<a class="headerlink" href="#make-a-new-feature-branch" title="Permalink to this headline">¶</a></h2>
<p>When you are ready to make some changes to the code, you should start a new
branch. Branches that are for a collection of related edits are often called
‘feature branches’.</p>
<p>Making an new branch for each set of related changes will make it easier for
someone reviewing your branch to see what you are doing.</p>
<p>Choose an informative name for the branch to remind yourself and the rest of us
what the changes in the branch are for. For example <tt class="docutils literal"><span class="pre">add-ability-to-fly</span></tt>, or
<tt class="docutils literal"><span class="pre">buxfix-for-issue-42</span></tt>.</p>
<div class="highlight-python"><pre># Update the mirror of trunk
git fetch upstream
# Make new feature branch starting at current trunk
git branch my-new-feature upstream/master
git checkout my-new-feature</pre>
</div>
<p>Generally, you will want to keep your feature branches on your public <a href="#id23"><span class="problematic" id="id24">github_</span></a>
fork of <a href="#id25"><span class="problematic" id="id26">`networkx`_</span></a>. To do this, you <a href="#id27"><span class="problematic" id="id28">`git push`_</span></a> this new branch up to your
github repo. Generally (if you followed the instructions in these pages, and by
default), git will have a link to your github repo, called <tt class="docutils literal"><span class="pre">origin</span></tt>. You push
up to your own repo on github with:</p>
<div class="highlight-python"><pre>git push origin my-new-feature</pre>
</div>
<p>In git >= 1.7 you can ensure that the link is correctly set by using the
<tt class="docutils literal"><span class="pre">--set-upstream</span></tt> option:</p>
<div class="highlight-python"><pre>git push --set-upstream origin my-new-feature</pre>
</div>
<p>From now on git will know that <tt class="docutils literal"><span class="pre">my-new-feature</span></tt> is related to the
<tt class="docutils literal"><span class="pre">my-new-feature</span></tt> branch in the github repo.</p>
</div>
<div class="section" id="the-editing-workflow">
<span id="edit-flow"></span><h2>The editing workflow<a class="headerlink" href="#the-editing-workflow" title="Permalink to this headline">¶</a></h2>
<div class="section" id="overview">
<h3>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre># hack hack
git add my_new_file
git commit -am 'NF - some message'
git push</pre>
</div>
</div>
<div class="section" id="in-more-detail">
<h3>In more detail<a class="headerlink" href="#in-more-detail" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
<li><p class="first">Make some changes</p>
</li>
<li><p class="first">See which files have changed with <tt class="docutils literal"><span class="pre">git</span> <span class="pre">status</span></tt> (see <a href="#id29"><span class="problematic" id="id30">`git status`_</span></a>).
You’ll see a listing like this one:</p>
<div class="highlight-python"><pre># On branch ny-new-feature
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: README
#
# Untracked files:
# (use "git add <file>..." to include in what will be committed)
#
# INSTALL
no changes added to commit (use "git add" and/or "git commit -a")</pre>
</div>
</li>
<li><p class="first">Check what the actual changes are with <tt class="docutils literal"><span class="pre">git</span> <span class="pre">diff</span></tt> (<a href="#id31"><span class="problematic" id="id32">`git diff`_</span></a>).</p>
</li>
<li><p class="first">Add any new files to version control <tt class="docutils literal"><span class="pre">git</span> <span class="pre">add</span> <span class="pre">new_file_name</span></tt> (see
<a href="#id33"><span class="problematic" id="id34">`git add`_</span></a>).</p>
</li>
<li><p class="first">To commit all modified files into the local copy of your repo,, do
<tt class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-am</span> <span class="pre">'A</span> <span class="pre">commit</span> <span class="pre">message'</span></tt>. Note the <tt class="docutils literal"><span class="pre">-am</span></tt> options to
<tt class="docutils literal"><span class="pre">commit</span></tt>. The <tt class="docutils literal"><span class="pre">m</span></tt> flag just signals that you’re going to type a
message on the command line. The <tt class="docutils literal"><span class="pre">a</span></tt> flag <a href="#id5"><span class="problematic" id="id6">|emdash|</span></a> you can just take on
faith <a href="#id7"><span class="problematic" id="id8">|emdash|</span></a> or see <a href="#id35"><span class="problematic" id="id36">`why the -a flag?`_</span></a> <a href="#id9"><span class="problematic" id="id10">|emdash|</span></a> and the helpful use-case
description in the <a href="#id37"><span class="problematic" id="id38">`tangled working copy problem`_</span></a>. The <a href="#id39"><span class="problematic" id="id40">`git commit`_</span></a> manual
page might also be useful.</p>
</li>
<li><p class="first">To push the changes up to your forked repo on github, do a <tt class="docutils literal"><span class="pre">git</span>
<span class="pre">push</span></tt> (see <a href="#id41"><span class="problematic" id="id42">`git push`_</span></a>).</p>
</li>
</ol>
</div>
</div>
<div class="section" id="ask-for-your-changes-to-be-reviewed-or-merged">
<h2>Ask for your changes to be reviewed or merged<a class="headerlink" href="#ask-for-your-changes-to-be-reviewed-or-merged" title="Permalink to this headline">¶</a></h2>
<p>When you are ready to ask for someone to review your code and consider a merge:</p>
<ol class="arabic">
<li><p class="first">Go to the URL of your forked repo, say
<tt class="docutils literal"><span class="pre">http://github.com/your-user-name/networkx</span></tt>.</p>
</li>
<li><p class="first">Use the ‘Switch Branches’ dropdown menu near the top left of the page to
select the branch with your changes:</p>
<img alt="../../_images/branch_dropdown.png" src="../../_images/branch_dropdown.png" />
</li>
<li><p class="first">Click on the ‘Pull request’ button:</p>
<img alt="../../_images/pull_button.png" src="../../_images/pull_button.png" />
<p>Enter a title for the set of changes, and some explanation of what you’ve
done. Say if there is anything you’d like particular attention for - like a
complicated change or some code you are not happy with.</p>
<p>If you don’t think your request is ready to be merged, just say so in your
pull request message. This is still a good way of getting some preliminary
code review.</p>
</li>
</ol>
</div>
<div class="section" id="some-other-things-you-might-want-to-do">
<h2>Some other things you might want to do<a class="headerlink" href="#some-other-things-you-might-want-to-do" title="Permalink to this headline">¶</a></h2>
<div class="section" id="delete-a-branch-on-github">
<h3>Delete a branch on github<a class="headerlink" href="#delete-a-branch-on-github" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>git checkout master
# delete branch locally
git branch -D my-unwanted-branch
# delete branch on github
git push origin :my-unwanted-branch</pre>
</div>
<p>(Note the colon <tt class="docutils literal"><span class="pre">:</span></tt> before <tt class="docutils literal"><span class="pre">test-branch</span></tt>. See also:
<a class="reference external" href="http://github.com/guides/remove-a-remote-branch">http://github.com/guides/remove-a-remote-branch</a></p>
</div>
<div class="section" id="several-people-sharing-a-single-repository">
<h3>Several people sharing a single repository<a class="headerlink" href="#several-people-sharing-a-single-repository" title="Permalink to this headline">¶</a></h3>
<p>If you want to work on some stuff with other people, where you are all
committing into the same repository, or even the same branch, then just
share it via github.</p>
<p>First fork networkx into your account, as from <a class="reference internal" href="forking_hell.html#forking"><em>Making your own copy (fork) of networkx</em></a>.</p>
<p>Then, go to your forked repository github page, say
<tt class="docutils literal"><span class="pre">http://github.com/your-user-name/networkx</span></tt></p>
<p>Click on the ‘Admin’ button, and add anyone else to the repo as a
collaborator:</p>
<blockquote>
<div><img alt="../../_images/pull_button.png" src="../../_images/pull_button.png" />
</div></blockquote>
<p>Now all those people can do:</p>
<div class="highlight-python"><pre>git clone git@githhub.com:your-user-name/networkx.git</pre>
</div>
<p>Remember that links starting with <tt class="docutils literal"><span class="pre">git@</span></tt> use the ssh protocol and are
read-write; links starting with <tt class="docutils literal"><span class="pre">git://</span></tt> are read-only.</p>
<p>Your collaborators can then commit directly into that repo with the
usual:</p>
<div class="highlight-python"><pre>git commit -am 'ENH - much better code'
git push origin master # pushes directly into your repo</pre>
</div>
</div>
<div class="section" id="explore-your-repository">
<h3>Explore your repository<a class="headerlink" href="#explore-your-repository" title="Permalink to this headline">¶</a></h3>
<p>To see a graphical representation of the repository branches and
commits:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">gitk</span> <span class="o">--</span><span class="nb">all</span>
</pre></div>
</div>
<p>To see a linear list of commits for this branch:</p>
<div class="highlight-python"><pre>git log</pre>
</div>
<p>You can also look at the <a href="#id43"><span class="problematic" id="id44">`network graph visualizer`_</span></a> for your github
repo.</p>
<p>Finally the <a class="reference internal" href="configure_git.html#fancy-log"><em>Fancy log output</em></a> <tt class="docutils literal"><span class="pre">lg</span></tt> alias will give you a reasonable text-based
graph of the repository.</p>
</div>
<div class="section" id="rebasing-on-trunk">
<span id="rebase-on-trunk"></span><h3>Rebasing on trunk<a class="headerlink" href="#rebasing-on-trunk" title="Permalink to this headline">¶</a></h3>
<p>Let’s say you thought of some work you’d like to do. You
<a class="reference internal" href="#update-mirror-trunk"><em>Update the mirror of trunk</em></a> and <a class="reference internal" href="#make-feature-branch"><em>Make a new feature branch</em></a> called
<tt class="docutils literal"><span class="pre">cool-feature</span></tt>. At this stage trunk is at some commit, let’s call it E. Now
you make some new commits on your <tt class="docutils literal"><span class="pre">cool-feature</span></tt> branch, let’s call them A, B,
C. Maybe your changes take a while, or you come back to them after a while. In
the meantime, trunk has progressed from commit E to commit (say) G:</p>
<div class="highlight-python"><pre> A---B---C cool-feature
/
D---E---F---G trunk</pre>
</div>
<p>At this stage you consider merging trunk into your feature branch, and you
remember that this here page sternly advises you not to do that, because the
history will get messy. Most of the time you can just ask for a review, and not
worry that trunk has got a little ahead. But sometimes, the changes in trunk
might affect your changes, and you need to harmonize them. In this situation
you may prefer to do a rebase.</p>
<p>rebase takes your changes (A, B, C) and replays them as if they had been made to
the current state of <tt class="docutils literal"><span class="pre">trunk</span></tt>. In other words, in this case, it takes the
changes represented by A, B, C and replays them on top of G. After the rebase,
your history will look like this:</p>
<div class="highlight-python"><pre> A'--B'--C' cool-feature
/
D---E---F---G trunk</pre>
</div>
<p>See <a href="#id45"><span class="problematic" id="id46">`rebase without tears`_</span></a> for more detail.</p>
<p>To do a rebase on trunk:</p>
<div class="highlight-python"><pre># Update the mirror of trunk
git fetch upstream
# go to the feature branch
git checkout cool-feature
# make a backup in case you mess up
git branch tmp cool-feature
# rebase cool-feature onto trunk
git rebase --onto upstream/master upstream/master cool-feature</pre>
</div>
<p>In this situation, where you are already on branch <tt class="docutils literal"><span class="pre">cool-feature</span></tt>, the last
command can be written more succinctly as:</p>
<div class="highlight-python"><pre>git rebase upstream/master</pre>
</div>
<p>When all looks good you can delete your backup branch:</p>
<div class="highlight-python"><pre>git branch -D tmp</pre>
</div>
<p>If it doesn’t look good you may need to have a look at
<a class="reference internal" href="#recovering-from-mess-up"><em>Recovering from mess-ups</em></a>.</p>
<p>If you have made changes to files that have also changed in trunk, this may
generate merge conflicts that you need to resolve - see the <a href="#id47"><span class="problematic" id="id48">`git rebase`_</span></a> man
page for some instructions at the end of the “Description” section. There is
some related help on merging in the git user manual - see <a href="#id49"><span class="problematic" id="id50">`resolving a merge`_</span></a>.</p>
</div>
<div class="section" id="recovering-from-mess-ups">
<span id="recovering-from-mess-up"></span><h3>Recovering from mess-ups<a class="headerlink" href="#recovering-from-mess-ups" title="Permalink to this headline">¶</a></h3>
<p>Sometimes, you mess up merges or rebases. Luckily, in git it is
relatively straightforward to recover from such mistakes.</p>
<p>If you mess up during a rebase:</p>
<div class="highlight-python"><pre>git rebase --abort</pre>
</div>
<p>If you notice you messed up after the rebase:</p>
<div class="highlight-python"><pre># reset branch back to the saved point
git reset --hard tmp</pre>
</div>
<p>If you forgot to make a backup branch:</p>
<div class="highlight-python"><pre># look at the reflog of the branch
git reflog show cool-feature
8630830 cool-feature@{0}: commit: BUG: io: close file handles immediately
278dd2a cool-feature@{1}: rebase finished: refs/heads/my-feature-branch onto 11ee694744f2552d
26aa21a cool-feature@{2}: commit: BUG: lib: make seek_gzip_factory not leak gzip obj
...
# reset the branch to where it was before the botched rebase
git reset --hard cool-feature@{2}</pre>
</div>
</div>
<div class="section" id="rewriting-commit-history">
<span id="id2"></span><h3>Rewriting commit history<a class="headerlink" href="#rewriting-commit-history" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Do this only for your own feature branches.</p>
</div>
<p>There’s an embarassing typo in a commit you made? Or perhaps the you
made several false starts you would like the posterity not to see.</p>
<p>This can be done via <em>interactive rebasing</em>.</p>
<p>Suppose that the commit history looks like this:</p>
<div class="highlight-python"><pre>git log --oneline
eadc391 Fix some remaining bugs
a815645 Modify it so that it works
2dec1ac Fix a few bugs + disable
13d7934 First implementation
6ad92e5 * masked is now an instance of a new object, MaskedConstant
29001ed Add pre-nep for a copule of structured_array_extensions.
...</pre>
</div>
<p>and <tt class="docutils literal"><span class="pre">6ad92e5</span></tt> is the last commit in the <tt class="docutils literal"><span class="pre">cool-feature</span></tt> branch. Suppose we
want to make the following changes:</p>
<ul class="simple">
<li>Rewrite the commit message for <tt class="docutils literal"><span class="pre">13d7934</span></tt> to something more sensible.</li>
<li>Combine the commits <tt class="docutils literal"><span class="pre">2dec1ac</span></tt>, <tt class="docutils literal"><span class="pre">a815645</span></tt>, <tt class="docutils literal"><span class="pre">eadc391</span></tt> into a single one.</li>
</ul>
<p>We do as follows:</p>
<div class="highlight-python"><pre># make a backup of the current state
git branch tmp HEAD
# interactive rebase
git rebase -i 6ad92e5</pre>
</div>
<p>This will open an editor with the following text in it:</p>
<div class="highlight-python"><pre>pick 13d7934 First implementation
pick 2dec1ac Fix a few bugs + disable
pick a815645 Modify it so that it works
pick eadc391 Fix some remaining bugs
# Rebase 6ad92e5..eadc391 onto 6ad92e5
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit's log message
#
# If you remove a line here THAT COMMIT WILL BE LOST.
# However, if you remove everything, the rebase will be aborted.
#</pre>
</div>
<p>To achieve what we want, we will make the following changes to it:</p>
<div class="highlight-python"><pre>r 13d7934 First implementation
pick 2dec1ac Fix a few bugs + disable
f a815645 Modify it so that it works
f eadc391 Fix some remaining bugs</pre>
</div>
<p>This means that (i) we want to edit the commit message for
<tt class="docutils literal"><span class="pre">13d7934</span></tt>, and (ii) collapse the last three commits into one. Now we
save and quit the editor.</p>
<p>Git will then immediately bring up an editor for editing the commit
message. After revising it, we get the output:</p>
<div class="highlight-python"><pre>[detached HEAD 721fc64] FOO: First implementation
2 files changed, 199 insertions(+), 66 deletions(-)
[detached HEAD 0f22701] Fix a few bugs + disable
1 files changed, 79 insertions(+), 61 deletions(-)
Successfully rebased and updated refs/heads/my-feature-branch.</pre>
</div>
<p>and the history looks now like this:</p>
<div class="highlight-python"><pre>0f22701 Fix a few bugs + disable
721fc64 ENH: Sophisticated feature
6ad92e5 * masked is now an instance of a new object, MaskedConstant</pre>
</div>
<p>If it went wrong, recovery is again possible as explained <a class="reference internal" href="#recovering-from-mess-up"><em>above</em></a>.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="maintainer_workflow.html" title="Maintainer workflow"
>next</a> |</li>
<li class="right" >
<a href="configure_git.html" title="Configure git"
>previous</a> |</li>
<li><a href="http://networkx.github.com/">NetworkX Home </a> | </li>
<li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li>
<li><a href="http://networkx.github.com/download.html">Download </a> | </li>
<li><a href="http://github.com/networkx">Developer (Github)</a></li>
<li><a href="../index.html" >Developer Guide</a> »</li>
<li><a href="index.html" >Working with <em>networkx</em> source code</a> »</li>
<li><a href="git_development.html" >Git for development</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, NetworkX Developers.
Last updated on Oct 23, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
