FlightGear Git: Difference between revisions

Added git commands and fgdata.bundle
(Added git commands and fgdata.bundle)
Line 14: Line 14:
Also, as noted before, 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.


== 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:
== Repositories and Branches ==
For historical reasons there continue to be separate repositories for SimGear and FlightGear source. 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.
Line 23: Line 24:
[http://www.kernel.org/pub/software/scm/git/docs/howto/maintain-git.txt 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.
[http://www.kernel.org/pub/software/scm/git/docs/howto/maintain-git.txt 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.


==Quick checkout==
Brief notes:


== Clone and handle Repositories ==
=== Quick checkout ===
# Check on gitorious for valid projects: http://gitorious.org/fg
# Check on gitorious for valid projects: http://gitorious.org/fg
# Cloning Simgear
# Cloning Simgear
Line 31: Line 32:
# Cloning FGData
# Cloning FGData


By default you will be checking out the next branch of SimGear and FlightGear. This is probably what you want if you want to assist with reporting bugs and the like before they are release as a proper release version.
By default you will be checking out the <tt>next</tt> branch of SimGear and FlightGear. This is probably what you want if you want to assist with reporting bugs and the like before they are release as a proper release version.
 
 
=== For dummies ===
Some basic git commands on how to clone, update and handle local git repositories. Except the initial ''git clone'' for each repository all commands have to be executed from within the ''target'' folder.<BR>
 
==== Cloning SimGear ====
;<code>git clone git://gitorious.org/fg/simgear.git [target]</code>
: the folder ''target'' will be created and a clone of the SimGear repo stored inside it. If no ''target'' is given the new folder's name is <code>simgear</code>.
 
<b><code>cd</code></b> into the new folder. You are then inside the ''working directory'' of this git repo. The repo itself is stored inside the subfolder <tt>.git</tt>, which we mustn't edit manually. Git will take care of that.
 
;<code>git branch</code>
: will show the active [[FlightGear_and_Git#Repositories and Branches|branch]]. Right after download this will be <tt>* next</tt>, that means the content of the ''working directory'' is the bleeding edge of SimGear's source code.
:;<code>git branch -a</code>
:: will list all branches of a git repository. The one marked with an asterisk (*) is the active one.
 
;<code>git checkout master</code>
: will change the active [[FlightGear_and_Git#Repositories_and_Branches|branch]] to <tt>master</tt>. Means, that the content of the ''working directory'' will be changed to that state.


===Cloning SimGear===
:;<code>git checkout v2.0.0</code>
$ git clone git://gitorious.org/fg/simgear.git
:: will activate the state of the code inside the <tt>master</tt> branch at the time FG 2.0.0 was released.
Initialized empty Git repository in /home/gpatterson/project/flightgear/compiles/simgear/.git/
:;<code>git tag</code>
remote: Counting objects: 19784, done.
:: will show all tags of the history of the active branch.
remote: Compressing objects: 100% (5896/5896), done.
remote: Total 19784 (delta 15095), reused 17731 (delta 13610)
Receiving objects: 100% (19784/19784), 6.85 MiB | 88 KiB/s, done.
Resolving deltas: 100% (15095/15095), done.


===Cloning FlightGear===
;<code>git pull</code>
$ git clone git://gitorious.org/fg/flightgear.git
: will update the local repo from the remote one.
  Initialized empty Git repository in /home/gpatterson/project/flightgear/compiles/flightgear/.git/
 
  remote: Counting objects: 72119, done.
 
  remote: Compressing objects: 100% (17140/17140), done.
==== Cloning FlightGear ====
  remote: Total 72119 (delta 57619), reused 68255 (delta 54756)
Except for the initial clone command this is identic to [[FlightGear_and_Git#Cloning_SimGear|Cloning SimGear]].
  Receiving objects: 100% (72119/72119), 19.56 MiB | 111 KiB/s, done.
;<code>git clone git://gitorious.org/fg/flightgear.git [target]</code>
  Resolving deltas: 100% (57619/57619), done.
To successfully compile <code>fgfs</code> Sim- and FlightGear's repositories must have the same state.
 
 
==== Cloning fgdata ====
At the time of writing the data repository is about 2.5 GB of size. Revisit an interrupted cloning of a repository is *not* possible with git. Therefore, if you have a slow or unstable connection to the internet, it is recommended to download the [[FlightGear_and_Git#fgdata.bundle|fgdata.bundle]].
 
Also have in mind, that the repository plus the ''working directory'' will be more than twice the size of the download on your local filesystem.
 
There is neither a <tt>next</tt> branch nor any tags in that repository. If you want to get FlightGear 2.0.0 you may fetch the data (FlightGear-data-2.0.0.tar.bz2) at one of the [http://flightgear.org/mirrors.html mirrors].
 
;<code>git clone git://mapserver.flightgear.org/fgdata/ [target]</code>
: if no ''target'' is given the new folder's name is <tt>fgdata</tt>
<b><code>cd</code></b> into the new directory and verify it's state with <b><code>git branch</code></b>. If it isn't <tt>* master</tt>, do a <b><code>git checkout master</code></b>.
 
 
==== Individual Branch ====
To make individual changes, like adding/editing a joystick file to fgdata or patch the source code, it is recommended to create an individual branch inside that repository:
 
<b><code>cd</code></b> into the repositories folder, e.g. fgdata:
;<code>git checkout -b master.individual master</code>
: a new branch <tt>master.individual</tt> is created out of the <tt>master</tt> branch and set as the active one. You may apply your individual stuff there.
 
To update that individual branch from the remote one do the following steps:
git checkout master              # switch to master branch
git pull                        # update it
git checkout master.individual  # switch back to the individual branch
git rebase next                  # update it
 
 
==== Some more helpful commands ====
;<code>git help</code>
;<code>git help [commad]</code>
;<code>git apply</code>
: apply a patch to files and/or to the index http://www.kernel.org/pub/software/scm/git/docs/git-apply.html
;<code>git checkout -f</code>
: is used to throw away any local changes to a repository. Use with care, as any option that name is <tt>-f</tt> or <tt>--force</tt>!
 
 
=== fgdata.bundle ===
For the FlightGear-data there are also bundles (snapshots) available that can be retrieved with your favorite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.
 
Download the bundle from
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle
or
$ wget http://peter-server.homelinux.net/fgdata/fgdata/fgdata.bundle
 
The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2010-06-09 is 2394168314, while the md5 checksum is
$ md5sum fgdata.bundle
2996221bd2b8ab7740f332f49396cf56  fgdata.bundle
 
Do the following steps to extract the bundle and bring the repository up to date:
$ git clone fgdata.bundle fgdata
  Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" --/position/longitude += "-deg" - /radios/adf/frequencies/selected += "-khz" - /radios/adf/frequencies/
warning: remote HEAD refers to nonexistent ref, unable to checkout.
$ cd fgdata
$ git branch master-tmp origin/master
Branch master-tmp set up to track remote branch refs/remotes/origin/master.
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
  remote: Counting objects: 5596, done.
  remote: Compressing objects: 100% (2919/2919), done.
  remote: Total 4266 (delta 2540), reused 2166 (delta 1297)
  Receiving objects: 100% (4266/4266), 117.93 MiB | 1374 KiB/s, done.
  Resolving deltas: 100% (2540/2540), completed with 628 local objects.
From git://gitorious.org/fg/fgdata
  * [new branch]      PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
  * [new branch]      master    -> origin/master
  * [new tag]        last-cvs  -> last-cvs
  * [new tag]        mapserver  -> mapserver
$ git branch -D master-tmp
Deleted branch master-tmp.
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout
 
If you get an error at <b><code>git fetch origin</code></b> try:
$ git remote rm origin
$ git remote add origin git://mapserver.flightgear.org/fgdata/
$ git fetch origin
 
For future updates just do a <b><code>git pull</code></b>.


===Cloning FGData===
$ git clone git://mapserver.flightgear.org/fgdata/
Cloning into fgdata...
remote: Counting objects: 140178, done.
remote: Compressing objects: 100% (58872/58872), done.
remote: Total 140178 (delta 84344), reused 131129 (delta 79051)
Receiving objects: 100% (140178/140178), 2.54 GiB | 1.67 MiB/s, done.
Resolving deltas: 100% (84344/84344), done.


==External links==
==External links==
Line 70: Line 159:
* [http://sourceforge.net/projects/qgit qgit - interactive git repository viewer and frontend]
* [http://sourceforge.net/projects/qgit qgit - interactive git repository viewer and frontend]
* Additional [[Resources WRT running git on Win32]]
* Additional [[Resources WRT running git on Win32]]
{{Building}}
392

edits