FlightGear Git: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 4: Line 4:
* '''Mac OS X:''' [[FlightGear Git on Mac OS X]]
* '''Mac OS X:''' [[FlightGear Git on Mac OS X]]
* '''Windows:''' [[FlightGear Git on Windows]]
* '''Windows:''' [[FlightGear Git on Windows]]
==Quick start==
To check out the maintenance branch of [[SimGear]]:
git clone git://gitorious.org/fg/simgear.git
cd simgear
git checkout -b maint origin/maint
Repeat that for FlightGear, with a slightly different command:
git clone git://gitorious.org/fg/flightgear.git
cd flightgear
git checkout -b maint origin/maint
The base package is available at http://gitorious.org/fg/fgdata, which we clone:
git clone git://gitorious.org/fg/fgdata
'''According to IRC chat:'''<br>
If you receive errors linking against "OpenThreads" leave your local git copy branch to "next". Don't checkout branches "maint" for neither repository.


== Motivation ==
== Motivation ==
Line 31: Line 11:
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.


Also, the CVS servers had a hardware failure on May 2010, speeding up FlightGear's change to Git.
Also, as noted before, the CVS servers had a hardware failure on May 2010, speeding up FlightGear's change to Git.


== FlightGear and Git ==
== Repositories ==
For historical reasons there continue to be separate repositories for Simgear and Flightgear. There are 3 interesting branches in the repositories. Listed in order from least stable to most:
For historical reasons there continue to be separate repositories for Simgear and Flightgear. There are 3 interesting branches in the repositories. Listed in order from least stable to most:
* <tt>next</tt> The current tip of new development. This branch should always compile and run, but various things could be broken.
* <tt>next</tt> The current tip of new development. This branch should always compile and run, but various things could be broken.
* <tt>master</tt> The tip of stable, tested new features. If we were to make a new release today, we would start from the tip of this branch. New features that have been "cooking" in the <tt>next</tt> branch for a few days or weeks will be merged here.
* <tt>master</tt> The tip of stable, tested new features. If we were to make a new release today, we would start from the tip of this branch. New features that have been "cooking" in the <tt>next</tt> branch for a few days or weeks will be merged here.
* <tt>maint</tt> Bug fixes for the most recently released Flightgear. When a release is made from <tt>master</tt>, this branch is reset to it.
* <tt>maint</tt> Bug fixes for the most recently released Flightgear. When a release is made from <tt>master</tt>, this branch is reset to it.
<!--For now, almost every commit in <tt>next</tt>, <tt>master</tt> and <tt>maint</tt> are identical to commits in the CVS repositories, and the contents of <tt>next</tt> should be identical to those of CVS HEAD. You can verify this:
git diff origin/cvs..origin/next
should return nothing. The only commits that don't exist in CVS are those that set the version numbers of the maintenance releases because the maintenance releases don't exist as such in CVS.
Even though the contents of <tt>next</tt> are the same as CVS HEAD, its history is different. It includes many merges from <tt>maint</tt> and branches based on <tt>maint</tt>. This makes it easier to move new work from <tt>next</tt> back to <tt>master</tt> and <tt>maint</tt> after it has had time to cook. --!>


This arrangement follows the scheme used by the Git maintainers.
This arrangement follows the scheme used by the Git maintainers.

Revision as of 20:54, 4 June 2010

In May 2010, after a hardware failure on the CVS servers, the FlightGear project changed version control system from CVS to Git. The Git repositories are located at Gitorious.

Due to the recent switch, we are currently doing our best on providing manuals for obtaining FlightGear through Git. The following articles are work in progress as of June 1st:

Motivation

Much has been written on the advantages of Git over CVS. For us, some advantages are:

  • Much better support for branches and merging branches. This is especially important for creating bug-fix releases for major releases while still allowing work on the next major release to continue. It is also very nice for a developer's personal workflow.
  • Easier path for contributors to submit changes and developers to integrate them;
  • Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.

Also, as noted before, the CVS servers had a hardware failure on May 2010, speeding up FlightGear's change to Git.

Repositories

For historical reasons there continue to be separate repositories for Simgear and Flightgear. There are 3 interesting branches in the repositories. Listed in order from least stable to most:

  • next The current tip of new development. This branch should always compile and run, but various things could be broken.
  • master The tip of stable, tested new features. If we were to make a new release today, we would start from the tip of this branch. New features that have been "cooking" in the next branch for a few days or weeks will be merged here.
  • maint Bug fixes for the most recently released Flightgear. When a release is made from master, this branch is reset to it.

This arrangement follows the scheme used by the Git maintainers. This description is very technical; you will surely have achieved git-fu if completely understand it. However, the idea of maintaining several branches of different stability is common in collaborative software projects.

External links

Git tutorials and resources