[deliverable/tracecompass.git] / doc / README

This describes how to build the documentation found in the
org.eclipse.tracecompass.*.doc.* plugins.


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