# qiBuild documentation

# qiBuild Python framework design

## General design decisions

qiBuild Python framework is designed around a few principles:

- Be modular : it should be easy to extend the command line API

- Have loosely-coupled, isolated components. This allows us to:

  > - Easily write automatic tests
  > - Easily refactoring code when there is a need to it.

- Have a nice user interface. This means:

  > - Nice, helpful error messages
  > - Colorful output when possible
  > - Nice and always up-to-date built-in help
  > - Let the use type less when possible

- Be intuitive: follow the principle of least surprise

- Prefer convention over configuration: configuration files should containing nothing more that necessary, and easy to generate automatically.

qiBuild does something non-standard, though: it forces use to use the build directory it has generated for you.

This is the only way we can make sure the use will not end up mixing build directories (for instance mixing a 64 bits build directory used to compile a library for your desktop, with a build directory used when cross compiling).

## Concepts

action
  Basically, the second argument of the qibuild command line. It always matches a python module. For instance, when calling qibuild make, we will be using the action named qibuild.actions.make.

worktree
  A worktree is simply a directory tree containing a `.qi` folder as its root.

See also

- `qisys.worktree`

WorkTrees can be nested, although this is not recommended (situation can get a little confused if you do so)

A worktree should also contain a `.qi/worktree.xml` configuration file, used to track the projects inside the worktree.

A worktree can also contain a `.qi/qibuild.xml` configuration file, used to store specific build settings for this worktree

See also

- qibuild.xml configuration file syntax

Project
  A qibuild project is simply a directory containing a `qiproject.xml` file at its root. The project must belong to a worktree, which means that one of the parent directories of the project directory must be a `.qi` directory. This simple algorithm means it’s easy for qibuild to find project paths and names inside a worktree, but it also means you cannot have several projects with the same name inside the same worktree.

The name of the project is given inside the `qproject.xml` file, like this:

    <project name="foo" />

See also

- qiproject.xml syntax
- project

By convention, the name of the project matches the subdirectory name, (that’s what `qibuild convert` will do, for instance), but this is not mandatory.

Note that although qibuild comes with a tool to manage several git repositories (called qisrc), there is absolutely no problems in having a project not in a git repositories, or several projects inside the same directory.

Projects directory can be nested, but this is not recommended either.

Also note that nothing forces a qibuild project to be a CMake project.

We will just check that the project contains a root CMakeLists when running qibuild configure, but that’s all.

More specifically, we do NOT assume the project uses the qibuild CMake framework.

manifest
  A manifest is simply a list of URL for projects. Right now only git URLs are supported, but conceptually nothing prevents you to use svn URL, or simply url to sources archives, and so on.

See also

- qisrc manifest syntax

toolchain
  See toolchain in the qiBuild CMake Concepts section. From qibuild point of view, every toolchain has a name and correspond to a specific configuration.
Package
  See package in the qiBuild CMake Concepts section. From qitoolchain point of view, every package has a name and a path, and optionally a toolchain file.

build configuration

  A build configuration is just a name. Usually it matches a toolchain name, but you can also add:

  > - some specific CMake flags
  > - a specific CMake generator

  A build configuration is always associated to a build directory. You cannot have two different build configurations sharing the same build directory.

## qibuild Python packages documentation

See qiBuild Python documentation for a documentation of the main packages, classes and functions of the qiBuild Python Framework.

## Overviews

You can read the following sections if you want to understand deeply how the qibuild command line tools work under the hood.

- qibuild internal overviews

Changelog CMake index Python index Index