Release plan: Difference between revisions

Line 196: Line 196:
* perform a sync with JSBSim sources before the feature freeze.
* perform a sync with JSBSim sources before the feature freeze.
* Changelog / Release Announcement:
* Changelog / Release Announcement:
** To get to the 3.0 goal sometime in the near future, it's probably a good  idea to create a backlog of open items in the wiki and link the release plan document to that. As usual, we don't have to be perfect for a new major release number. But the new features being the reason for the new major  number should work reasonably correct.  [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38888.html] (also see [[:Category:Developer Plans]])
** {{Thumbs up}} Posting the link to the changelog for the upcoming release helped writing the changelog early, this should also be done for the [[Hardware Recommendations]] and [[Notebooks known to run FlightGear]] pages probably?
** {{Thumbs up}} Posting the link to the changelog for the upcoming release helped writing the changelog early, this should also be done for the [[Hardware Recommendations]] and [[Notebooks known to run FlightGear]] pages probably?
** {{Thumbs up}} The changelog can be easily written by using "git log", searching the issue tracker and by going through the last 6 newsletters published since the previous release. It might make sense to explicitly add a "ChangeLog" message to important commits, so that the Changelog can be compiled more easily ?
** {{Thumbs up}} The changelog can be easily written by using "git log", searching the issue tracker and by going through the last 6 newsletters published since the previous release. It might make sense to explicitly add a "ChangeLog" message to important commits, so that the Changelog can be compiled more easily ?
Line 206: Line 207:
** modified shaders should be tested with other shader-related features to prevent breakage []
** modified shaders should be tested with other shader-related features to prevent breakage []
* FGData (Base Package):
* FGData (Base Package):
** Language files should be synced between English and other languages, so translators can work on them before the release ;-)
** the [https://gitorious.org/fg/flightgear/blobs/next/scripts/python/nasal_api_doc.py nasal_api_doc.py] script in $FG_SRC/scripts/python should be run as part of the release process, to create an updated doc file for $FG_ROOT/Docs and ship it with each release [http://flightgear.org/forums/viewtopic.php?f=30&t=15133]
** the [https://gitorious.org/fg/flightgear/blobs/next/scripts/python/nasal_api_doc.py nasal_api_doc.py] script in $FG_SRC/scripts/python should be run as part of the release process, to create an updated doc file for $FG_ROOT/Docs and ship it with each release [http://flightgear.org/forums/viewtopic.php?f=30&t=15133]
** New/updated Nasal scripts contributed to the base package should be checked to properly support important features like simulator reset, this also applies to Nasal scripts used by aircraft, Nasal scripts that fail these criteria, end up breaking existing features! [https://code.google.com/p/flightgear-bugs/issues/detail?id=956] (also see [[Release:Aircraft Selection Criteria]])
** New/updated Nasal scripts contributed to the base package should be checked to properly support important features like simulator reset, this also applies to Nasal scripts used by aircraft, Nasal scripts that fail these criteria, end up breaking existing features! [https://code.google.com/p/flightgear-bugs/issues/detail?id=956] (also see [[Release:Aircraft Selection Criteria]])
Line 219: Line 221:
** For RC's it might make sense to distribute binaries with debugging symbols included, so that people can more easily provide useful bug reports, or even backtraces.
** For RC's it might make sense to distribute binaries with debugging symbols included, so that people can more easily provide useful bug reports, or even backtraces.
** Also, many end users still prefer using the forum for making bug reports and don't use the issue tracker - it might help to add a link (button) to the issue tracker to the about dialog or maybe even directly to the help menu ("Report an issue") (same for wiki/troubleshooting/faq ?)
** Also, many end users still prefer using the forum for making bug reports and don't use the issue tracker - it might help to add a link (button) to the issue tracker to the about dialog or maybe even directly to the help menu ("Report an issue") (same for wiki/troubleshooting/faq ?)
* To get to the 3.0 goal sometime in the near future, it's probably a good  idea to create a backlog of open items in the wiki and link the release plan document to that. As usual, we don't have to be perfect for a new major release number. But the new features being the reason for the new major  number should work reasonably correct.  [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38888.html] (also see [[:Category:Developer Plans]])
* A normal Linux user has practically no chance to get last stable on his box running if it isn't in his distro - a normal Windows user gets everything nice and streamlined. [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38817.html]
* A normal Linux user has practically no chance to get last stable on his box running if it isn't in his distro - a normal Windows user gets everything nice and streamlined. [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg38817.html]
* According to the issue tracker there were 3-5 different contributors who provided C++ patches that didn't end up reviewed/merged, which caused some irritation.
* According to the issue tracker there were 3-5 different contributors who provided C++ patches that didn't end up reviewed/merged, which caused some irritation.
* {{Thumbs up}} regarding aircraft included in the release: "I must stress usefulness of the Autostart feature, present in most aircraft not running at startup. It keeps frustration away from those who just want to enjoy the flight . (Please note that I actually agree with aircraft being shut down at startup, as long as autostart is present, or the starting procedure is trivially doable by just trying what you see in the cockpit.) " [http://flightgear.org/forums/viewtopic.php?f=3&t=18240&p=175117#p175117] (also see [[Release:Aircraft Selection Criteria]])
* {{Thumbs up}} regarding aircraft included in the release: "I must stress usefulness of the Autostart feature, present in most aircraft not running at startup. It keeps frustration away from those who just want to enjoy the flight . (Please note that I actually agree with aircraft being shut down at startup, as long as autostart is present, or the starting procedure is trivially doable by just trying what you see in the cockpit.) " [http://flightgear.org/forums/viewtopic.php?f=3&t=18240&p=175117#p175117] (also see [[Release:Aircraft Selection Criteria]])
* {{Thumbs up}} also, it would apparently make sense to provide tutorials for the default aircraft: "At first startup, I noticed the "Need help? use help->tutorials" message, and because I had no idea how to start up the plane (it would be just plain try and fail, than try something else), I did just that and started some basic tutorials. I wouldn't say going through the tutorials was frustrating, but they were quite boring and I was eager to get in the air as soon as possible." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795] (also see [[Release:Aircraft Selection Criteria]])
* {{Thumbs up}} also, it would apparently make sense to provide tutorials for the default aircraft: "At first startup, I noticed the "Need help? use help->tutorials" message, and because I had no idea how to start up the plane (it would be just plain try and fail, than try something else), I did just that and started some basic tutorials. I wouldn't say going through the tutorials was frustrating, but they were quite boring and I was eager to get in the air as soon as possible." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795] (also see [[Release:Aircraft Selection Criteria]])
* Language files should be synced between English and other languages, so translators can work on them before the release ;-)
* "I discovered however, that there can be some problems on Linux about the planes (eg. some versions of the L39 Albatros undergoing several improvements lately). The problems can be caused by Linux being case sensitive about file paths (Windows is not), and I suspect, more models could suffer from some developers not knowing that. It's easy to fix if you know about the problem, but it would better be done on the developer side, as you never know if the smoke is just not implemented or missing due to this. Not to mention how lengthy it would be to go through more aircraft..." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]
* "I discovered however, that there can be some problems on Linux about the planes (eg. some versions of the L39 Albatros undergoing several improvements lately). The problems can be caused by Linux being case sensitive about file paths (Windows is not), and I suspect, more models could suffer from some developers not knowing that. It's easy to fix if you know about the problem, but it would better be done on the developer side, as you never know if the smoke is just not implemented or missing due to this. Not to mention how lengthy it would be to go through more aircraft..." [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]
* I also vote for hosting a non-GPL hangar on the FG site, and tighter coordination with the aircraft developers (I think they should be asked to actively propose their models to the hangar once it is created, of course there could be link to their site/hangar). It would help nice models to be more easily found, an more people could enjoy them. And that's why people spend time creating them, right? [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]
* I also vote for hosting a non-GPL hangar on the FG site, and tighter coordination with the aircraft developers (I think they should be asked to actively propose their models to the hangar once it is created, of course there could be link to their site/hangar). It would help nice models to be more easily found, an more people could enjoy them. And that's why people spend time creating them, right? [http://www.flightgear.org/forums/viewtopic.php?f=28&t=16795]