Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The API documentation can be built with Maven using the following commands (should work on 4.1 and above). The belt-and-braces approach which always work is to build everything:

  1.  mvn -Pdeveloper -Dnoredist clean install

However if you've just edited the .xsl files since building you can use:

  1. mvn -Pdeveloper -Dnoredist clean install -pl :cloud-apidoc

Built The built documentation can then be found here: tools/apidoc/target/xmldoc/html

...

You can call it with the following command:

Code Block
java -cp ~/.m2/repository/com/thoughtworks/xstream/xstream/1.4.310/xstream-1.4.310.jar:/path/to/source/cloudstack/dist/rpmbuild/BUILD/cloudstack-4.212.0-SNAPSHOT/server/target/classes \
com.cloud.api.doc.ApiXmlDocReader -old /path/to/4.011.commands.xml -new /path/to/4.112.commands.xml -d /path/to/diff/

...