From 47e5016083cad418ce93ad9331dbab92100edbca Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Wed, 27 Feb 2013 16:10:58 -0500 Subject: [PATCH] Add README files for ctf.parser and {lttng|tmf}.help 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 Reviewed-on: https://git.eclipse.org/r/10718 Tested-by: Hudson CI Reviewed-by: Bernd Hufmann IP-Clean: Bernd Hufmann Tested-by: Bernd Hufmann Reviewed-by: Patrick Tasse IP-Clean: Patrick Tasse --- org.eclipse.linuxtools.ctf.parser/README | 31 ++++++++++++++++++++++++ org.eclipse.linuxtools.lttng.help/README | 19 +++++++++++++++ org.eclipse.linuxtools.tmf.help/README | 19 +++++++++++++++ 3 files changed, 69 insertions(+) create mode 100644 org.eclipse.linuxtools.ctf.parser/README create mode 100644 org.eclipse.linuxtools.lttng.help/README create mode 100644 org.eclipse.linuxtools.tmf.help/README diff --git a/org.eclipse.linuxtools.ctf.parser/README b/org.eclipse.linuxtools.ctf.parser/README new file mode 100644 index 0000000000..a6720624bd --- /dev/null +++ b/org.eclipse.linuxtools.ctf.parser/README @@ -0,0 +1,31 @@ +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 diff --git a/org.eclipse.linuxtools.lttng.help/README b/org.eclipse.linuxtools.lttng.help/README new file mode 100644 index 0000000000..38b3f9df7c --- /dev/null +++ b/org.eclipse.linuxtools.lttng.help/README @@ -0,0 +1,19 @@ +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 diff --git a/org.eclipse.linuxtools.tmf.help/README b/org.eclipse.linuxtools.tmf.help/README new file mode 100644 index 0000000000..588523b222 --- /dev/null +++ b/org.eclipse.linuxtools.tmf.help/README @@ -0,0 +1,19 @@ +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 -- 2.34.1