Re: [linuxtools-dev] best practices for API Baselines and Errors/Warning

[Alexandre Montplaisir <alexmonthy@xxxxxxxxxxxx>]

Hi Aaron,

On 13-09-03 06:34 PM, Aaron Spear wrote:
> Hi all, 
>
> I am merging my LTTng viewer prototype code with the latest in master. On a clean stock Kepler workspace I see a slew of errors about missing @since javadoc tags, as well as errors saying that the @since 2.0 tags ought to be @since 2.1 and such. (sorry I changed it and now I don't have the exact text) 
>
> It seems like I had to go under Plug-in Development > API Errors/Warnings > Version Management and change everything to be Warnings and not Errors in order to get it to build at all. Is this right? How do you guys have this set up during your development?

If you follow the instructions at
http://wiki.eclipse.org/Linux_Tools_Project/LTTng_Eclipse_Plug-in_Development_Environement_Setup#Define_an_API_baseline_.28optional.29
you should not get any errors with latest master (if you do, please file
bugs/patches!). This requires keeping the baseline installation
up-to-date, so today a baseline install should be 2.0, and when 2.1
comes out it should be updated to 2.1, etc.

What I think is happening in your case is that your baseline is at a
version before 2.0. So the tool sees many @since 2.0 methods that are
not part of your baseline, so it thinks they are new in the current
version (2.1). Updating your baseline to 2.0 should fix it.

Note that 2.1 has already been branched, but we normally bump the
version in master only after the stable release is made. That way
developers can update their baseline using the standard update site (see
section "Update the baseline" in the link above).

> Perhaps related to this, I am wondering where/how I get API baselines for previous releases. e.g. is there some XML file I import, or perhaps API baselines can be imported as a part of an epf file?

I agree, having some kind of "symbols" file would make things much
easier! But from what I understand, it only supports actual, compiled
plugins as the baseline. It's possible to use a very bare installation,
like an update site built with Maven, but I've always had trouble trying
to set that up. So I just use a full-blown Eclipse install on the side
with the plugins installed manually in it.

Hope this helps.

Cheers,
Alex

>
> thanks,
> Aaron 
>