Developer Guide - Git Workflows

Description

This document attempts to write down and motivate some of the workflow elements used for managing the development of Bering-uClibc with git. This guide was an adapted version of the GitWorkflows document that is used for the git project.

Separate changes

As a general rule, you should try to split your changes into small logical steps, and commit each of them. They should be consistent, working independently of any later commits, pass the build, etc. This makes the review process much easier, and the history much more useful for later inspection and analysis, for example with git-blame(1) and git-bisect(1).

To achieve this, try to split your work into small steps from the very beginning. It is always easier to squash a few commits together than to split one big commit into several. Don’t be afraid of making too small or imperfect steps along the way. You can always go back later and edit the commits with git rebase --interactive before you publish them. You can use git stash save --keep-index to try a build independent of other uncommitted changes; see the EXAMPLES section of git-stash(1).

Managing Branches

There are two main tools that can be used to include changes from one branch on another: git-merge(1) and git-cherry-pick(1).

Merges have many advantages, so we try to solve as many problems as possible with merges alone. Cherry-picking is still occasionally useful; see "Merging upwards" below for an example.

Most importantly, merging works at the branch level, while cherry-picking works at the commit level. This means that a merge can carry over the changes from 1, 10, or 1000 commits with equal ease, which in turn means the workflow scales much better to a large number of contributors (and contributions). Merges are also easier to understand because a merge commit is a promise that all changes from all its parents are now included.

There is a tradeoff of course: merges require a more careful branch management. The following subsections discuss the important points.

Graduation

As a given feature goes from experimental to stable, it also "graduates" between the corresponding branches of the software. Bering-uClibc uses the following integration branches:

• maint tracks the commits that should go into the next "maintenance release", i.e., update of the last released stable version;
• master tracks the commits that should go into the next release;
• next is intended as a testing branch for topics being tested for stability for master.

There is a fourth official branch that is used slightly differently:

• pu (proposed updates) is an throw-away integration branch for things that are not quite ready for inclusion yet (see "Throw-away integration Branches" below).

Each of the four branches is usually a direct descendant of the one above it.

Conceptually, the feature enters at an unstable branch (usually next or pu), and "graduates" to master for the next release once it is considered stable enough.

Merging upwards

The "downwards graduation" (for example from next to master) discussed above cannot be done by actually merging downwards, however, since that would merge all changes on the unstable branch into the stable one. Hence the following:

Rule: Merge upwards

Always commit your fixes to the oldest supported branch that require them. Then (periodically) merge the integration branches upwards into each other.

This gives a very controlled flow of fixes. If you notice that you have applied a fix to e.g. master that is also required in maint, you will need to cherry-pick it (using git-cherry-pick(1)) downwards. This will happen a few times and is nothing to worry about unless you do it very frequently.

Topic branches

Any nontrivial feature will require several patches to implement, and may get extra bugfixes or improvements during its lifetime.

Committing everything directly on the integration branches leads to many problems: Bad commits cannot be undone, so they must be reverted one by one, which creates confusing histories and further error potential when you forget to revert part of a group of changes. Working in parallel mixes up the changes, creating further confusion.

Use of "topic branches" solves these problems. The name is pretty self explanatory, with a caveat that comes from the "merge upwards" rule above:

Rule: Topic branches

• Make a side branch for every topic (feature, bugfix, …). Fork it off at the oldest integration branch that you will eventually want to merge it into. For example for a bugfix in maint fork off your topic branch from maint. For a new feature fork it off from the master (never from the next that is an experimental branch that can be rewind).

Many things can then be done very naturally:

• To get the feature/bugfix into an integration branch, simply merge it. If the topic has evolved further in the meantime, merge again. (Note that you do not necessarily have to merge it to the oldest integration branch first. For example, you can first merge a bugfix to next, give it some testing time, and merge to maint when you know it is stable.)
• If you find you need new features from the branch other to continue working on your topic, merge other to topic. (However, do not do this "just habitually", see below.)
• If you find you forked off the wrong branch and want to move it "back in time", use git-rebase(1).

Note that the last point clashes with the other two: a topic that has been merged elsewhere should not be rebased. See the section on RECOVERING FROM UPSTREAM REBASE in git-rebase(1).

We should point out that "habitually" (regularly for no real reason) merging an integration branch into your topics — and by extension, merging anything upstream into anything downstream on a regular basis — is frowned upon because:

Rule: Merge to downstream only at well-defined points

• Do not merge to downstream except with a good reason: upstream API changes affect your branch; your branch no longer merges to upstream cleanly; etc.

Otherwise, the topic that was merged to suddenly contains more than a single (well-separated) change. The many resulting small merges will greatly clutter up history. Anyone who later investigates the history of a file will have to find out whether that merge affected the topic in development. An upstream might even inadvertently be merged into a "more stable" branch. And so on.

So for resuming, when you have fork off a new topic branch (from master for example) do not merge your topic branch from the branch that was used to fork off ("habitually" users merge theirs topic branches from the branch that was used to fork off to be in sync with the integration branch: DON'T DO THAT IT'S REALLY A BAD IDEA !). The only merge that was good for a topic branch is to merge into an integration branch.

Throw-away integration

If you followed the last paragraph, you will now have many small topic branches, and occasionally wonder how they interact. Perhaps the result of merging them does not even work? But on the other hand, we want to avoid merging them anywhere "stable" because such merges cannot easily be undone.

The solution, of course, is to make a merge that we can undo: merge into a throw-away branch.

Rule: Throw-away integration branches

To test the interaction of several topics, merge them into a throw-away branch. You must never base any work on such a branch!

If you make it (very) clear that this branch is going to be deleted right after the testing, you can even publish this branch, for example to give the testers a chance to work with it, or other developers a chance to see if their in-progress work will be compatible. Bering-uClibc has such an official throw-away integration branch called pu.

Branch management for bugfix in maintenance branch

To commmit the bugfix into maint branch you only have to merge you bugfix topic branch into maint:

• Sync your maint branch with the remote repository and check that you don't have uncommited changes:

git checkout maint
git pull --rebase -p
git log origin/maint..maint

The last command should not list any commits. Otherwise, you have uncommited changes (it's bad because you don't have to commit directly on the integration branches (see #Topic branches). So you need commit them or stash them.

• Merge you bugfix topic branch into maint and push to the public remote repository. For example:

git merge my-bugfix
git push origin maint

Now as the master is supposed to be a superset of maint you need to checkout the master branch and merge the maint into it:

git checkout master
git pull --rebase -p
git merge --no-commit maint

Resolve the conflicts if some exists. Then if the bugfix commit in maint branch should not be applied (completely or not) into the master use commands like git reset -p to unstage parts that you don't want to commit into the master branch.

• Commit the merge into master:

git commit

If you have remove some parts during the merge, put a notice in the commit message to tell why the bugfix was not apply completely.

• Push the new commit to the remote repository:

git push origin master

• Clean up your worktree (removing parts that was not commited):

git checkout :/

Branch management for a release

Assuming you are using the merge approach discussed above, when you are releasing your project you will need to do some additional branch management work.

A feature release is created from the master branch, since master tracks the commits that should go into the next feature release.

The master branch is supposed to be a superset of maint. If this condition does not hold, then maint contains some commits that are not included on master. The fixes represented by those commits will therefore not be included in your feature release.

To verify that master is indeed a superset of maint, use git log:

Recipe: Verify master is a superset of maint

git log master..maint

This command should not list any commits. Otherwise, check out master and merge maint into it.

Now you can proceed with the creation of the feature release.

Recipe: Creation of a feature release

• Sync your master branch with the remote repository and check that you don't have uncommited changes:

git checkout master
git pull --rebase -p
git log origin/master..master

The last command should not list any commits. Otherwise, you have uncommited changes (it's bad because you don't have to commit directly on the integration branches (see #Topic branches). So you need commit them or stash them.

• Create a new commit to tell that is a new release, then tag it. For example:

# bump the version number then create a commit for the new release
git commit -a -m "Bering-uClibc 5.0-rc0"
git tag -a -m "Release of LEAF Bering-uClibc 5.0-rc0" v5.0-rc0

• Push the new commit and tag to the public git server:

git push origin master
git push origin v5.0-rc0

This makes the tag available to others tracking your project. The push could also trigger a post-update hook to perform release-related items such as building release tarballs and preformatted documentation pages.