Skip to content

Commit 8ce07da

Browse files
author
Rok Strniša
committed
Added detailed instructions for setting it up with xapi.
1 parent f857075 commit 8ce07da

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,20 @@ daemon to run alongside [xen-api](https://github.com/xen-org/xen-api).
66
Even this minimal daemon has a few dependencies, e.g. `http-svr`, `stunnel`,
77
`xml-light2`, `rpc-light`, and `camlp4`. If the repository is cloned within
88
the `ocaml` directory of [xen-api](https://github.com/xen-org/xen-api), all
9-
the dependencies should be satisfied.
9+
of these dependencies should be satisfied.
1010

11-
## Compiling
11+
## Setting up with xen-api
1212

13-
* The daemon server can be compiled by running `omake daemon_server`.
14-
* The daemon client can be compiled by running `omake daemon_client`.
15-
* The test can be run by running `omake test`.
16-
17-
You might need to define a global variable `OPTDIR`, e.g.:
18-
19-
export OPTDIR=""
13+
* Clone the repository within `xen-api/ocaml`.
14+
* Rename the repository's directory to `<my_daemon>`.
15+
* Remove `.git`, `.gitignore`, and `README.md` within the `<my_daemon>`
16+
directory.
17+
* Add `<my_daemon>` to `.SUBDIRS` variable in `xen-api/ocaml/OMakefile`.
18+
* Enter `xen-api`'s `chroot`.
19+
* Enter `xen-api`'s directory and compile it with `make`.
20+
* Enter the `<my_daemon>` directory.
21+
* Ensure that global variable `OPTDIR` is defined. If not, define it with
22+
`export OPTDIR=""`.
23+
* Compile the daemon server by running `omake daemon_server`.
24+
* Compile the daemon client by running `omake daemon_client`.
25+
* Run the test by running `omake test`.

0 commit comments

Comments
 (0)