Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 361203

Summary:	[Documentation] Explain the extra download of antler's generator briefly in the installation section.
Product:	[Modeling] TMF	Reporter:	Barrie Treloar <baerrach>
Component:	Xtext	Assignee:	Project Inbox <tmf.xtext-inbox>
Status:	CLOSED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	jan, sebastian.zarnekow, sven.efftinge
Version:	2.1.0	Flags:	sebastian.zarnekow: juno+
Target Milestone:	RC2
Hardware:	All
OS:	All
Whiteboard:

Description Barrie Treloar

2011-10-18 01:52:34 EDT

The license conditions http://www.antlr.org/license.html allow redistribution in binary form.

When behind a firewall the prompt to download this file fails.

It would be preferable to bundle this jar with XText.

  The workaround is to manually download the file and to create a "Create a User Library" and then "Add a User Library to a Run Configuration"
  I installed the downloaded file into the root of my Eclipse installation.

Comment 1 Sven Efftinge

2011-10-18 02:17:52 EDT

It's not possible to include it in a download from eclipse.org (for IP reasons).
However it's included on the following update site http://download.itemis.com/updates/

Comment 2 Barrie Treloar

2011-10-18 02:36:19 EDT

Can you provide more explanation please?

The web pages dont list this as valid update site:
http://www.eclipse.org/Xtext/download/

Can I at least request that the documentation be updated to include 
* Why its necessary to download antlr-generator-3.2.0.jar separately
* What to do if you are behind a firewall (e.g. switch to the itemis update site)

I can't be the only one behind a firewall that's just made up the solution for this fix.  What will happen when XText moves to ANTLR 4?  Is my solution maintainable?

Comment 3 Sven Efftinge

2011-10-18 03:46:06 EDT

(In reply to comment #2) 
> Can I at least request that the documentation be updated to include 
> * Why its necessary to download antlr-generator-3.2.0.jar separately

The Eclipse lawyer's didn't approve the library to be included with the download because of pedigree issues. I.e. It's not clear who wrote each line of Antlr 2, so the license
is not guaranteed. 

> * What to do if you are behind a firewall (e.g. switch to the itemis update
> site)

Yes, we should mention that briefly in the tutorial.

> 
> I can't be the only one behind a firewall that's just made up the solution for
> this fix.  What will happen when XText moves to ANTLR 4?  Is my solution
> maintainable?

Xtext won't move to Antlr 4 any time soon for API compatibility reasons. But if, then the IP issue would go away, since for Antlr 4 Terence tracked who contributed.

I'm sorry for the inconvenience, but it indeed your are one of very few people who ran into this issue. We decided to not confuse everybody with lengthy explanations about different downloads, IP issues and the like as long as the current solution will work nicely for 95% of all users. 

But mentioning the itemis update site briefly shouldn't be too confusing :-)

Comment 4 Barrie Treloar

2011-10-18 05:56:13 EDT

That would be much appreciated.

Comment 5 Sebastian Zarnekow

2011-11-10 16:06:01 EST

We should do that for 2.2.

Comment 6 Jan Koehnlein

2012-05-24 10:23:59 EDT

Fix pushed to MASTER.

Comment 7 Eclipse Webmaster

2017-10-31 10:47:08 EDT

Requested via bug 522520.

-M.

Comment 8 Eclipse Webmaster

2017-10-31 10:58:19 EDT

Requested via bug 522520.

-M.