Jump to: navigation, search

Howto:Submit patches

1,761 bytes removed, 13:52, 4 May 2012
Update, link to Git merge requests
{{Out of date}}   === Patch Guidelines === 
Any invasive or non-trivial patches should preferably adhere to the following recommendations:
* Search the [ flightgear-devel list archives] ([ old]) for any relevant discussion and then post to the flightgear-devel [[mailing list]] describing your idea and discussing the scope of effort required.
 * if If you have developed several different features, make sure '''not''' to provide one big patch for all of these changes, but instead several smaller ones for each individual feature (likewise, use separate threads on the mailing list as well), that way you will enable developers to easily and independently review/discuss your patches [].
* Try to make your patch optionally minimally invasive:
* If you need to print output to the terminal, make sure to use the SG_LOG logging mechanism, using the appropriate log level. Use this command sparingly, as excessive logging information has negative impact on framerate, especially on some platforms (you can however easily use switches to generally enable/disable output of debugging information). When committing a patch, make sure you have either removed or commented out any cout or cerr statements that you have used during private debugging sessions.
=== Patch Format ===TODO: unified diff vs. tarball (compressed archives) === Howto Create Patches === '''fg-submit script''' As of March 2007, a bash script "fg-submit" is available that simplifies the preparation of create and share patches that are to be submitted for commit. It can be found in '/source/scripts/tools'. It compares your changes to cvs, creates a diff file and an archive containing your changed files and the diff file. Run this script from within the CVS directory containing your changes. It's output will go to that same directory. fg-submit should work with any flavor of Unix/Linux. Windows users may use this script from within a Cygwin bash shell, assuming the necessary Devel tools have been installed. Usage: $ cd $FG_ROOT/Aircraft/foo $ fg-submit '''TODO:'''  links to diff/patch tutorialslink to diff/patch utilities for various platforms recommended: KDiff3 (QT based cross platform, GUI frontend to GNU diff/patch) === Where to Send Patches === '''Developers with CVS access :''' '''FlightGear developer mailing list(subscription required)''' (any non-trivial or larger patches should preferably not be sent by email, but rather made available by putting a tarball of your patch on some free webspace, so that people can simply download your patch if they are interested.  '''Note''':The FlightGear project's sourceforge site [] also provides a simple patch tracking facility [], which is easy and intuitive to use and doesn't require any complicated sign up process. While this facility is not yet being used regularly by the project, it may still help you making your patches and code easily accessible.{{Main article|Merge request}}

Navigation menu