Re: [incquery-dev] API docs updated

[Ujhelyi Zoltán <ujhelyiz@xxxxxxxxxx>]

> 
>> As far as I know, the sample UI generator is unfinished and is not included in the packaged versions of EMF-IncQuery.
> 
> As far as I can tell, it is working properly:
> - it has been completely refactored to the new namespace,
> - the generated code is error free and works well.
> (I only tested it with the school example though.)
Ok, then I was mistaken about its correct working state. Then it is only not included in the build (the one who updated this in the past did not put it there). I have created a ticket to fix this: https://bugs.eclipse.org/bugs/show_bug.cgi?id=404300


> So why not include it in the builds? Also, I think that having some feature in the Git repo only (and not building and packaging it) is generally bad practice, for two main reasons:
> - as we (the developers) are working primarily with checked out projects, it can be misleading for us (e.g. in this case the @Handler annotation is available in all of our developer workspaces, whereas for our users it is not available)
> - if things are not built automatically, we will not know if we break them with some change.

I understand this reason, that is why the IncQuery viewers are already compiled in the build, but are not packaged yet into the update site (this will change soon - it is close to presentable). Now that I checked, the sample UI generator works similarly.

> For unfinished projects, there still is the IncQuery-Addons repo on GitHub. I think at the eclipse.org repo we should make sure that _everything_ is auto-built and packaged in some available form (e.g. through an "experimental" update site or whatever), and I also think that the sample UI generator should be included in the standard (milestone) builds.

Be careful with the GitHub repository. If we want to include any code from there, we have to go through a CQ, similar to the initial commit. Sometimes it makes sense to put the code there as we want to have a more liberal development policy - e.g. student contributors. If we are experimenting with other features, but only IncQuery committers are developing it, and we plan to integrate the results in eclipse.org hosted update sites, it is generally favorable to develop it on eclipse.org. However, nobody is stopping us from creating an 'incubation'/'experimental' repository for incquery (incubation terminology is more often used here, but I know it has a different meaning.

Zoli
> Istvan
> 
> 
> 
>> 
>> Cheers,
>> Zoli
>> -- Zoltán Ujhelyi
>> https://www.inf.mit.bme.hu/en/members/ujhelyiz
>> 
>> Fault Tolerant Systems Research Group
>> Budapest University of Technology and Economics
>> 
>> On 2013.03.25., at 13:03, Istvan Rath <rath@xxxxxxxxxx (mailto:rath@xxxxxxxxxx)> wrote:
>> 
>>> Hi,  
>>> 
>>> I have recently invested quite a lot of effort into sanitizing our API documentation. The most up-to-date version can be found on the wiki here:
>>> http://wiki.eclipse.org/EMFIncQuery/UserDocumentation/API
>>> 
>>> In the process, I have also updated the "headless" example to the newest version.
>>> 
>>> All this is intended to replace old content here:
>>> http://incquery.net/incquery/documentation/api
>>> http://incquery.net/incquery/new/examples/application
>>> http://incquery.net/incquery/new/examples/school#Generated_code_overview (https://incquery.net/incquery/new/examples/school#Generated_code_overview)
>>> 
>>> 
>>> 
>>> I would very much appreciate your comments and input on this work. Known issues are:
>>> - the "DeltaMonitor" part is a TODO as I'm not entirely sure what is the most up-to-date info here
>>> - the Generic API is missing details and possibly contains incorrect statements.
>>> 
>>> cheers
>>> Istvan
>>> 
>>> --
>>> Istvan RATH, PhD
>>> Research fellow
>>> Budapest University of Technology and Economics
>>> Fault Tolerant Systems Research Group
>>> 
>>> 
>>> _______________________________________________
>>> incquery-dev mailing list
>>> incquery-dev@xxxxxxxxxxx (mailto:incquery-dev@xxxxxxxxxxx)
>>> http://dev.eclipse.org/mailman/listinfo/incquery-dev
>>> 
>> 
>> 
>> _______________________________________________
>> incquery-dev mailing list
>> incquery-dev@xxxxxxxxxxx (mailto:incquery-dev@xxxxxxxxxxx)
>> http://dev.eclipse.org/mailman/listinfo/incquery-dev
>> 
>> 
> 
> 
> _______________________________________________
> incquery-dev mailing list
> incquery-dev@xxxxxxxxxxx
> http://dev.eclipse.org/mailman/listinfo/incquery-dev