936
edits
User:Callahanp: Difference between revisions
Jump to navigation
Jump to search
m
→Development Operations
| Line 18: | Line 18: | ||
[[https://github.com/c172p-team/c172p C172P Team on Github ]] | [[https://github.com/c172p-team/c172p C172P Team on Github ]] | ||
=== Development Operations === | === Development Operations === | ||
I am making an effort to define and show examples of development operations for various parts of Flightgear Code and Data including all SourceForge Git repositories, Scenery, Aircraft, Aircraft Hangars, Airport Data. Add-Ons and anything else that can be used with Flightgear. | I am making an effort to define and show examples of development operations for various parts of Flightgear Code and Data including all SourceForge Git repositories, Scenery, Aircraft, Aircraft Hangars, Airport Data. Add-Ons and anything else that can be used with Flightgear. | ||
Operations include obtaining source materials, preparatory steps, operational readiness tasks, building, modifying, debugging, testing, and submitting changes. I'll explain further and give examples of the individual operations needed to accomplish these tasks for all types of FlightGear material, whether source code or data, regardless of the type of file or where it's upstream repository resides. | |||
When finished, this guide is intended to be complete. If you participate in the development of anything used with or within flightgear, with few exceptions, you'll be able to find information on specific commands and procedures needed to complete the eight operational tasks. It's currently under rapid development, with attention focused currently on correctly obtaining source materials for C & C++ programming of the main application. | |||
Here are a few examples of the Operations of each type: | |||
{| class="wikitable" | |||
|- | |||
! Operation Category !! Examples | |||
|- | |||
| Obtaining Source Materials || <li>Cloning Flightgear Git Repositories Locally </li> <li>Creating Personal Forks of Flightgear Repositories and cloning them locally </li> | |||
|- | |||
| preparatory steps || <li>installing pre-requisite software</li><li> collecting information about the exact current location for upstream source code and data </li> <li> Establishing a SourceForge Account</li> <li> Creating an SSH Key and readying it for use with Sourceforge </li> <li>Establishing a build script that can be used with multiple branches and which can build Release, RelWithDebInfo and Debug versions of executables</li> | |||
|- | |||
| Operational Readiness Tasks || <li>Ensuring that when switching branches, that changes on the previously current branch are not lost</li> <li>Ensuring that local clones used in a build are on the correct branch for the desired build</li> | |||
|- | |||
| Building || Executing a script containing a series of CMake commands to build specific parts of flightgear || Executing a script or program that processes data in raw form to produce a different form of data directly usable by FlightGear (OSM data for example) | |||
|- | |||
| Modifying || <li>Using an Editor or IDE to modify or add C++ Code </li><li> Using Blender to do something to an aircraft </li><li>Adding a building to scenery</li> | |||
|- | |||
| Debugging || <li>Using the GDB debugger in command line mode </li><li>Using the GDB debugger in an IDE</li>- | |||
| testing || Example || Example || Example | |||
|- | |||
| Submitting changes || <li>Doing a git push to a personal fork for a branch created for a specific set of changes </li>Creating a merge request for changes present on a personal fork.<li></li> | |||
|} | |||
Many of the source materials for the flightgear application are maintained as repositories on SourceForge. [https://sourceforge.net/p/flightgear/_list/git Complete FlightGear SourceForge Repository List]. Two of these Repositories are no longer used: FGCom and FGRun. These repositories are obsolete because their functional parts have been included within FlightGear. | |||
These four repositories make up the core Flightgear Application | |||
* [https://sourceforge.net/p/flightgear/fgdata/ fgdata] | |||
* [https://sourceforge.net/p/flightgear/simgear/ simgear] | |||
* [https://sourceforge.net/p/flightgear/flightgear/ flightgear] | |||
* [https://sourceforge.net/p/flightgear/fgmeta/ fgmeta] | |||
This special purpose repository is used when building flightgear on Windows by users who prefer to use pre-build pre-requisite packages. | |||
* [https://sourceforge.net/p/flightgear/windows-3rd-party/ windows-3rd-party] | |||
These repositories are for items such as a manual, web services used with flightgear, and addtional data that is separately downloaded by the running application. | |||
* [https://sourceforge.net/p/flightgear/getstart/ getstart] | |||
* [https://sourceforge.net/p/flightgear/maclauncher/ maclauncher] | |||
* [https://sourceforge.net/p/flightgear/openradar/ openradar] | |||
* [https://sourceforge.net/p/flightgear/sceneryweb/ sceneryweb] | |||
* [https://sourceforge.net/p/flightgear/terragear/ terragear] | |||
* [https://sourceforge.net/p/flightgear/terrafs/ terrafs] | |||
* [https://sourceforge.net/p/flightgear/navdata/ navdata] | |||
* [https://sourceforge.net/p/flightgear/pipeline/ pipeline] | |||
* [https://sourceforge.net/p/flightgear/mpmap.js/ mpmap] | |||
==== Part 1 - Creating a Sourceforge Fork ==== | ==== Part 1 - Creating a Sourceforge Fork ==== | ||
| Line 107: | Line 138: | ||
Once they're read, is there a way to organize them so the result is an overview? | Once they're read, is there a way to organize them so the result is an overview? | ||
Sure there is. Just write a book: | Sure there is. Just write a book: | ||
=== IDEs === | === IDEs === | ||