qiBuild documentation

qisrc manifest syntax


This file is used by the qisrc init command to get a list of projects to fetch and add in the current work tree.


Right now, only git URLs are supported.

An minimal example may be

  <remote name="origin" url="git://example.com" />
  <repo project="foo/bar.git" remotes="origin" src="bar" />

Here the repository from git://example.com/foo/bar.git will be cloned into QI_WORTREE/bar

manifest node

The manifest node accepts three types of children

  • remote node
  • repo node
  • groups node
  • import node

remote node

The remote node must have a url attribute, that will be used as a base URL for every project.

You can have several remotes with different names, like this:

  <remote name="public" url="git://github.com" />
  <remote name="origin" url="ssh://git@git.aldebaran.com" />
  • ssh://git@git.aldebaran.com/naoqi/naoqi.git will be cloned into naoqi, (because the default remote is origin)
  • git://github.com/aldebaran/qibuild.git will be cloned into tools/qibuild. (because public is used as remote)

Many types of url are supported:

  • file://
  • http://
  • git://
  • ssh://<username>@<host> when using ssh
  • ssh://<username>@<host>:<port> when using ssh on a non-standard port

Additionally, if you are using gerrit with ssh, you can specify that the remote will be used for code review (this is useful to change qisrc push behavior, so that changes are pushed to refs/for/master ).

  <remote name="gerrit" url="ssh://review.corp.com:29418" review="true"/>

Since when using gerrit, you have several usernames, the username is asked by qisrc when the manifest is parsed.

repo node

The repo node must have a project attribute.

It also must have a remotes attribute matching some existing remote nodes.

If src is not given, it will deduced from the project name. (for instance the foo/bar.git repo will be cloned to foo/bar)

   <remote name="origin" url="git://example.com" />
   <remote name="gerrit" url="ssh://review.corp.com:29418" review="true" />
   <repo project="bar/baz.git" remotes="origin gerrit" />

Here qisrc init will try to create an ssh connection with ssh://<username>@review.corp.com:29418, where username is read from the operating system first, or asked to the user.

The repository will be configured with two remotes: origin, and gerrit, and the commit-msg gerrit hook will be fetched automatically from <username>@<server>:hooks/commit-msg on the given port .

The repository will be cloned using the URL from the first remote.

Custom branch

By default, a master branch will be created tracking the remote used for cloning.

You can specify an other branch to use like this:

<repo project="bar/baz.git" remotes="origin" branch="devel" />

Here, a devel branch will be created, tracking origin/devel

Fixed reference

Lastly, instead of a branch you can specify a fixed reference. (A tag or a SHA1) In this case, no branch will be configured.

<repo project="bar/baz.git" remotes="origin" ref="v0.1" />

groups node

Groups nodes must have a name attribute. Then they contain a list of project name, and can include other groups.

  <group name="testing">
    <project name="gtest.git" />
    <project name="gmock.git" />
  <group name="core">
    <group name="testing" />
    <project name="libcore.git" />

Here we’ve defined a group named “testing”, so that it’s easy to get the gtest and gmock repositories together.

If someone uses qisrc init --group core, he will get gtest, gmock and libcore.

import node

import nodes must have a manifest attribute.

It also must have a remotes attribute matching some existing remote nodes.

This node is usefull to import a manifest from another git repository, all repo nodes and group of a manifest will be imported

<import manifest="testing/manifest.git" remotes="origin" branch="devel"/>

Here we have imported a manifest.xml from repository testing/manifest.git on branch devel the imported manifest.xml must have remote node(s) and repo node(s)