# Virgo Tooling Builds

## Hudson Builds

Virgo Tooling for the Eclipse IDE is built using the same toolchain as the rest of the Virgo project. The job can be found here: https://hudson.eclipse.org/hudson/job/virgo.ide.snapshot/.

to build from the command line?

## Building in Eclipse

If you want to explore, modify or contribute to the Virgo Tools, follow these steps to setup your workspace:

1. In most (but not all) cases, you'll want to have JEE and WTP features installed.
2. Clone the git repos at http://git.eclipse.org/c/virgo/org.eclipse.virgo.ide.git/
3. Import all of the projects within the repos.
4. Add Virgo IDE dependencies to your target platform if I haven't got a target platform? How do I create one? Does it need any special contents or configuration? . The best way to do that is to add the composite update site at http://download.eclipse.org/virgo/snapshot/tooling to your target platform and select the following items only. You'll need to uncheck "Group Items by Category" to see all of these.
   1. All Libra Features
   2. Eclipse Virgo Bundlor
   3. Eclipse Virgo Kernel
   4. Eclipse Virgo Medic
   5. Eclipse Virgo Utils

To launch the Virgo tools, just

1. Add all features but *..tests to an Eclipse runtime.
2. Add any WTP or JEE features appropriate for your target environment.
3. Be sure to select "Add Required Plugins".

## Building Documentation

The Eclipse documentation builds from the same documentation source as the rest of the Virgo build, all of which is maintained in the documentation repos. Currently, Eclipse doc builds are invoked manually. See this bug for more information.

1. If you do not already have it, clone the documentation repos at: http://git.eclipse.org/c/virgo/org.eclipse.virgo.documentation.git/.
2. The build should be in a parallel directory to your tooling repos. Alternatively, you can set the <code>virgo.docs.dir</code> property to the location of the documentation repos.
3. Optional: Update the Wiki Docs, see below.
4. From org.eclipse.virgo.ide.doc, execute "Build Virgo Docs" in External Tools. (This launches the build.xml using the workspace JRE.)

### Updating Wiki Text Documentation

We are also re-providing this Wiki documentation as part of the Eclipse Virgo feature. Unfortunately, we aren't able to update those documents automatically, as that would require committing changes into git, and resolving ordering issues there. Currently, the process works like this:

1. Execute ant build.xml in wiki-guide. This:
   1. Causes the Wiki Text to be built for use in the Virgo IDE Documentation.
   2. Builds docbook xml for use in the tooling-guide, and copies the relevant XML to that guide.
2. Execute the IDE build as described above.
3. The Virgo documentation will be updated with the tooling guide additions during the next scheduled Virgo docs build.

### Editing Media Wiki Documents

Note that there is now mediawiki support for the tooling documentation. This means that you can use mediawiki to write documentation, and we can easily crowd-source the latest documentation from the Virgo wiki pages. You can mix and match mediawiki documentation with ordinary docbook documentation. Just be sure not to edit mediawiki produced docs in the wikixml directory directly as they will be overwritten ! To build the wiki docs, just call:

    ant wiki-to-docbook

- Each wikitext document is a chapter.
- To add a new chapter to the tooling docs, edit <code>src/virgo-tooling-guide</code> and add the chapter to the <code>xi:include</code> entries with the path <code>../wikixml/your_chapter.xml</code>.

(This is not a build time task, it's simply an aid for creating the entire documentation set.)