On 2. Oct 2010, at 18:25, Martin Lambers wrote: > On 02/10/10 15:28, William Thibault wrote: >> Also, in trying to track the trunk, I'm missing things like the >> recent-ish library name change. >> What's the best way to stay informed of important changes to the API, etc? >> Does the Programmer Guide change as fast as the code? > > That's a problem here, too. We have to update our applications for each > release and this takes time. A file API-CHANGES or similar would help, > for example with entries like this: > > - 2010-04-07 Remove DataOStream::writeOnce > To update your application, replace calls to this function with the > following: ... > > Alternatively, a hint in the commit message would help.
Thanks for the feedback. I try to give hints in the commitMessage, but sometimes I forget and sometimes it's lost in the high volume on eq-commit. Starting with 1.0 there will be no undocumented API change, hopefully there will be no API change for the 1.0 API. So far I've been liberal with changing it, since we're not yet at 1.0. I think it's a good time to start tracking this now to get used to it. Is there a usual format/file used by OSS for this, or are we just make up our own? To answer Williams questions: the best way to stay informed of important changes to the API: eq-commit mailing list, the new CHANGES file. Does the Programmer Guide change as fast as the code?: I try to. Sometimes I forget to track the documentation. I have a full review path before each release to catch these. The P&UG has a version history as well. The library renaming has been discussed previously on this list. Cheers, Stefan. _______________________________________________ eq-dev mailing list [email protected] http://www.equalizergraphics.com/cgi-bin/mailman/listinfo/eq-dev http://www.equalizergraphics.com
