3.3. Populate Database

Example 3.9. Populating DOM4J API

   ~ashkelon$ cd apis
   ~ashkelon/apis$ ashkelon add dom4j.xml
   [press enter]

If everything goes well, you should end up with your database populated with the Java API documentation for DOM4J.

Ashkelon basically downloads the source code for the project (per the cvs or subversion repository information specific in the xml file) and places a copy in its "source cache" area on disk. Ashkelon the proceeds to invoke javadoc with itself as the doclet, in order to parse and populate the database with the API information.

You can list the APIs in the ashkelon database like this:

   eitan@ubuntu:~/projects/ashkelon/apis$ ashkelon list
   ashkelon@ubuntu:~/projects/ashkelon/apis$ ashkelon list
   Ashkelon: 1 APIs in ashkelon:
   Ashkelon:    dom4j

Continue to add as many APIs as you desire. They all get added to the same database and cross-references between APIs are resolved.


There's a bug at the moment with v0.9 regarding inability to autodetect and supply a cvs password. If for some reason ashkelon appears to have "hanged", usually after a line that resemples this:

CVS password: add: Logging in to :pserver:guest@cvs.dev.java.net:2401/cvs

Then this means that the invoked cvs command is waiting for a password before proceeding. Since almost all open source projects use a blank password for anonymous cvs login, simply press enter. I apologize for the inconvenience.