[deliverable/tracecompass.git] / org.eclipse.tracecompass.help / README

This describes how to build the documentation found in the o.e.t.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.
Commit	Line	Data
556101f3	1	This describes how to build the documentation found in the o.e.t.help plugin.
47e50160 AM	2
	3
	4	Your Eclipse environment first needs to have the "Mylyn Wikitext" plugin
	5	installed. It can be found in the default Eclipse repository, under
	6	"Collaboration".
	7
	8	Once that is installed, you should be able to use the manual Eclipse builder to
	9	generate the doc : select the lttng.help plugin and choose, in the top-menu,
	10	"Project -> Build Project".
	11
	12	It uses the build.xml Ant script, but it's recommended to run it from within
	13	Eclipse, since the builder will pass some environment variables that the script
	14	needs.
	15
	16	You might get a warning from build.properties because of a missing file. This
	17	file gets generated with the rest of the doc, so once you have run these steps
556101f3	18	(and refreshed the project if needed), the warning should disappear.