FlightGear Git: Difference between revisions

'''Git''' is a version control system used by the [[FlightGear]] project to store all of the files required to build the FlightGear, including all the programs, the data (e.g. [[aircraft]]), supporting tools, etc. Git tracks updates to every file as developers around the world work together concurrently to create new versions.  

While new FlightGear features and additions are in development, they are available from Git before they are available in the standard release version. Using Git allows users to build the newest possible version of FlightGear from the latest source files, to experiment with new aircraft or other features. However, it's not a beginner's tool. Using Git can expose the user to unstable features that show ugly error messages, or crash the computer.  

<br />

== '''Motivation''' ==

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

* 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.

== '''Manipulating the GIT''' ==

For a detailed description see the description of the 4 repositories (A,B,C,D) in the following chapters

<br /><br />

=== A) Repositories and branches ===

<br /><br />

=== B) Create your own workspace on Gitorious ===

* getstart

* etc.

* assist with reporting bugs before they are released as a proper release version

* or participate in the design

* or similar

<br /><br />

=== C) Create a "master" on your local PC ===

''All the following is shown as performed in an UBUNTU "Terminal" environment! Please adapt especially the directory trees according to your Operating-System!''

# Create a unique folder on your PC, e.g. "..'''\GIT'''"

#* ''if you need/want more informations about unique GIT-commands, input "git help [command]"'' <small>(e.g. "git help clone")</small>

# use one of the following commands (or similar) from within that "..'''\GIT'''"-folder:

'''<code>cd</code>''' into the new folder [target]

;<code>git branch</code>

<small>

  ..GIT/fgdata$ '''git branch'''

  * master

   master.local  <small>''(<-- this branch will not be there initially!)''</small>

;<code>git branch -a</code>

You now have your local "GIT-master".

<br /><br />

==== Special for '''fgdata''':====

Also have in mind, that the repository plus the ''working tree'' will be more than twice the size of the download on your local filesystem.

==== fgdata.bundle ====

Download the bundle from

  145f4e190fd1a02fd75c1d508b8c2ec3  fgdata.bundle  

Do the following steps to extract the bundle and bring the repository up to date:

  Your branch is ahead of 'origin/master' by 2 commits.

</small>

:;<code>git fetch</code>

<br />

  Switched to a new branch 'master.local'

</small>

:In case you get the response  

<small>

<br /><span style="color:green">

'''''You may now

*start FlightGear to verify they are proper/functional

*then check what was done:'''''

</span><br />

;<code>git status</code>

<small>

  ..GIT/fgdata$ '''git status'''

===="Commit"====

;<code>git commit -m "''your short, accompanying Announcement''"</code>

;<code>git log</code>

: You definitely should now copy the ID ''(the first 8 digits may be enough)'' to use it later as a unique identifier!

Now return to your local "master" with:

;<code>git checkout master</code>

;<code><nowiki>git fetch git://gitorious.org/fg/fgdata.git</nowiki></code>

:this will update the master to the newest GIT-level ''(there may have been changes during all that time!)''

;<code>git cherry-pick 7658c67c</code>

:will pull the commit into the "master"

<br />

=== Push your changes to your clone on Gitorious ===

<small>

::replace "YourID" with your login-name for Gitorious, do not forget the "~" in front of it!

Now you can announce to GIT that you have a change that may be merged into the original GIT:

*and click the "Request merge" button on the right:

<br />

||[[File:Create merge request at Gitorious.png|left|thumb|270px|Creating a merge request at Gitorious.]]||

Write a short summary in which you explain what your commit(s) do. Then choose the following settings:

Next select the commits you'd like to include in your merge request and click "Create merge request".

|}

<span style="color:red">'''''This step is for developers with fgdata commit access only!'''''</span>

<br />

<br />

  git checkout -b integration # the integration branch should not yet exist. You can use any name you'd like

  git pull git://gitorious.org/fg/fgdata.git refs/merge-requests/1 # make sure you change 1 to the id of the merge request

=== Some more helpful commands ===

;<code>git help</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

* Git [http://git-scm.com/documentation documentation and tutorials]

* Git Basics [http://schacon.github.com/git/gittutorial.html]

* The [http://zrusin.blogspot.com/2007/09/git-cheat-sheet.html Git Cheat Sheet] and the [http://jan-krueger.net/development/git-cheat-sheet-extended-edition Git Cheat Sheet Extended Edition]

* [http://wiki.github.com/bogolisk/egg Egg], a cool Git emacs mode.

* A guide to [http://nathanj.github.com/gitguide/ using Git on Windows]

* [http://kylecordes.com/2008/04/30/git-windows-go/ Git on Windows Go!] (Setting up msysgit on Windows)

* [http://sourceforge.net/projects/qgit qgit - interactive git repository viewer and frontend]

* Additional [[Resources WRT running git on Win32]]