XAPI Developer Guide

XAPI Developer Guide

This guide is a constantly evolving documentation effort to support developers learning about or working with XAPI.

OCaml Language

The XAPI toolstack is written entirely in OCaml. General information on the language is available at http://www.ocaml-tutorial.org/, which is mirrored at http://mirror.ocamlcore.org/ocaml-tutorial.org/.

• XAPI Source Documentation - OCamlDoc source-code documentation for XAPI
• OCaml Best Practices - Coding standards and guidelines for OCaml source code in XAPI.
• OCaml Editing - Various editor configurations
• OCaml Coding Considerations - Common issues in OCaml
• OCaml Errors - Code examples for various compiler errors
• OCaml Advice - Installation and configuration of OCaml
• OCaml Resources - Helpful Links for more information
• OCaml Cyclical Build Dependencies - Suggestions for cyclical build dependencies
• OCaml Doc - Techniques specific to the XAPI use of OCamlDoc

XAPI Tutorials

A collection of tutorials to better understand how to make changes to XAPI.

• XAPI Adding Field - Adding a field to an API in XAPI
• XAPI Adding Function - Adding an API function to XAPI

XAPI Projects

Projects currently being worked on and suggestions for future projects.

• XAPI project suggestions - Suggestions for new xapi projects

XAPI Internals

How XAPI Works...

• XAPI Startup - Startup process for XAPI
• VM Startup - VM startup process within XAPI
• XAPI VM Migration - How XAPI migrates VM
• XAPI Dispatch - Service dispatch and message forwarding mechanism
• XAPI Pool Join - Internal mechanism behind the pool join process