Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Adding API Baseline in Eclipse

In the compilation of eclipse source base. I have "An API baseline has not been set ..." error.

enter image description here

I tried to add API Baseline, but I don't know how to make or add it.

What's the API Baseline is for, and how can I add or make one?

enter image description here

enter image description here

like image 275
prosseek Avatar asked Nov 30 '12 18:11

prosseek


1 Answers

I try to answer the "What's the API Baseline is for, ..." part of the question.

API Baseline is a concept from PDE Tools / API Tools. They are intended to help you maintain plugins that others can use. They help you create compatible API versions.

The Problem:

  1. You create your plugin and release version 1 to the public.
  2. Millions of people will use your plugin and create their own code that depends on the API of your plugin.
  3. You release version 2 to the public. By mistake you change the API of your plugin.
  4. Millions of people update to the new version and have to adapt their code. Thousands of programs fail. People are sad.

The Solution:

  1. You create your plugin, annotate its API and release version 1 to the public.
  2. Millions of people will use your plugin and create their own code that depends on the API of your plugin.
  3. You declare version 1 of your plugin to be the API-Baseline that your code changes are automatically compared against. Any break in the API is presented to you before you release your plugin or run your tests. You release version 2 without any API changes.
  4. Millions of people can update your plugin in their application, because the new plugin release is binary compatible to the previous one.
  5. You declare version 2 of your plugin ....

Summary

If you develop a plugin just for your personal use and are not interested to maintain a compatible API, you can follow the advices to disable the warnings.

When you develop plugins for a community, e. g. the eclipse plugins themselves, it is essential that you keep API incompatibilities to a minimum. Then you will follow the advice and set the baseline to 4.2 when you develop for 4.3. The API tools will help you make 4.3 an enjoyment for all current 4.2 users.

Please note, that the API Tools are for the developers of the plugins that will be used by others. They are not addressed at the users of those plugins.

like image 103
Oliver Meyer Avatar answered Sep 23 '22 01:09

Oliver Meyer