Those plugins require special steps to build, so if somebody
hasn't read the wiki page, they can refer to these files for
the instructions.
Change-Id: Ic34f0e89491076b2e133b94bb52652336445552f
Signed-off-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Reviewed-on: https://git.eclipse.org/r/10718
Tested-by: Hudson CI
Reviewed-by: Bernd Hufmann <bhufmann@gmail.com>
IP-Clean: Bernd Hufmann <bhufmann@gmail.com>
Tested-by: Bernd Hufmann <bhufmann@gmail.com>
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
IP-Clean: Patrick Tasse <patrick.tasse@gmail.com>
--- /dev/null
+Getting compile errors in this plugin? Wondering why? Keep on reading!
+
+This file describes how to build the CTF Java parser files. They are not stored
+in the git repository anymore, and must be generated by the build system.
+
+Unfortunately there is no easy way to setup an Eclipse builder to generate those
+files, since the Antlr plugin in Orbit only provides the runtime, and not the
+tool to generate Java files.
+
+You have two options:
+- On Linux distros:
+ You can install Antlr 3.2, and then run the generate-grammar.sh script in this
+ directory. On Ubuntu 12.04, getting Antlr is a simple
+ $ sudo apt-get install antlr3
+
+ The files were only tested with Antlr 3.2 though, so they might not compile
+ with other versions.
+
+- On all systems:
+ For a more cross-platform solution you can use Maven to generate the parser
+ files. If you have Maven installed on your system, you can cd into this
+ directory and type "mvn install" in a terminal.
+
+ Another option is to install the Maven Eclipse integration plugin "m2e". It
+ can be found in the default Eclipse repository (under "Collaboration"). Once
+ it's installed, you can right-click the pom.xml file in this directory and
+ choose Run As -> Maven install.
+
+Both methods should create the Java files and put them in the correct directory.
+You may need to refresh the project, after which the compilation errors should
+disappear.
\ No newline at end of file
--- /dev/null
+This describes how to build the documentation found in the o.e.l.lttng.help
+plugin.
+
+
+Your Eclipse environment first needs to have the "Mylyn Wikitext" plugin
+installed. It can be found in the default Eclipse repository, under
+"Collaboration".
+
+Once that is installed, you should be able to use the manual Eclipse builder to
+generate the doc : select the lttng.help plugin and choose, in the top-menu,
+"Project -> Build Project".
+
+It uses the build.xml Ant script, but it's recommended to run it from within
+Eclipse, since the builder will pass some environment variables that the script
+needs.
+
+You might get a warning from build.properties because of a missing file. This
+file gets generated with the rest of the doc, so once you have run these steps
+(and refreshed the project if needed), the warning should disappear.
\ No newline at end of file
--- /dev/null
+This describes how to build the documentation found in the o.e.l.tmf.help
+plugin.
+
+
+Your Eclipse environment first needs to have the "Mylyn Wikitext" plugin
+installed. It can be found in the default Eclipse repository, under
+"Collaboration".
+
+Once that is installed, you should be able to use the manual Eclipse builder to
+generate the doc : select the tmf.help plugin and choose, in the top-menu,
+"Project -> Build Project".
+
+It uses the build.xml Ant script, but it's recommended to run it from within
+Eclipse, since the builder will pass some environment variables that the script
+needs.
+
+You might get a warning from build.properties because of a missing file. This
+file gets generated with the rest of the doc, so once you have run these steps
+(and refreshed the project if needed), the warning should disappear.
\ No newline at end of file
projects / deliverable / tracecompass.git / commitdiff
