qiBuild 1.14.5 documentation

Home | Search | Index | CMake index | Python index | Back to NAO Software Documentation

« previous | up | next »

qibuild.project – Managing projects

qibuild.project.Project

class qibuild.project.Project(name, directory)

Store information about a project

Main attributes

Those are set during initialization

Project.name

The name of the project

Project.directory

The source directory of the project

Project.depends

The list of build time depencies (read for qiproject.xml)

Project.rdepends

The list of runtime depencies (read for qiproject.xml)

Build related attributes:

Those need a toc instance to be correctly set, add update_project() must have been called.

Here is a small example:

$ qibuild make --release foo

When this is called, a toc ojbect is built with build_type=release and then the foo project and all its depencies are updated so that they contain -DCMAKE_BUILD_TYPE=RELEASE in their CMake flags.

Project.cmake_flags

CMake flags used.

Project.build_directory

The build_directory to use

Project.sdk_directory

Where to generate the build results. (By default in a ‘sdk’ directory inside the build directory, but use can choose to have a unique SDK dir for all projects)

Other functions in this module

qibuild.project.update_project(project, toc)

Update a project using a Toc instance:

This is to be called right after the toc object has been created, to be sure that the settings are consistent among all the projects.

This will set the following attributes:

• project.cmake_flags
• project.build_directory
• project.sdk_directory

qibuild.project.bootstrap_project(project, toc)

Create the magic build/dependencies.cmake file

This is to be called right before calling cmake inside the project build directory.

Note that update_project() must have been called first, and then only can we use toc.get_sdk_dirs

« qibuild.toc – TOC means Obvious Compilation | qibuild modules | qibuild.worktree – Using a worktree »

« previous | up | next »