# qiBuild documentation

# qibuild.worktree- The BuildWorkTree

## BuildWorkTree

class `qibuild.worktree.``BuildWorkTree`(worktree)

  Stores a list of projects that can be built using CMake.

  `build_config`

    See `CMakeBuildConfig`

  `dot_qi`

    Dot Qi

  `qibuild_cfg`

    QiBuild Config

  `qibuild_xml`

    Path to <worktree>/.qi/qibuild.xml. Will be created if it does not exist.

  `toolchain`

    The toolchain to use.

  `default_config`

    The default config to use.

  `venv_path`

    The virtualenv path associated with this worktree. Only exists if `qipy bootstrap` has been called.

  `generate_sourceme`()

    Generate a `sourceme` file to help running binaries using libraries from the build projects and the toolchain packages.

  `get_env`(extend_os_environ=True)

    Get an environment dictionary to help running binaries using libraries from the build projects and the toolchain packages.

  `get_known_profiles`(warns=True)

    Parse the remote profiles (coming from qisrc sync), and the local profiles (written in .qi/qibuild.xml). Return a dict name -> list of tuple (key, value)

  `get_build_project`(name, raises=True)

    Get a `BuildProject` given its name.

  `reload`()

    Reload

  `configure_build_profile`(name, flags)

    Configure a build profile for the worktree.

  `remove_build_profile`(name)

    Remove a build profile for this worktree.

  `set_default_config`(name)

    Set the default toolchain for this worktree.

  `set_active_config`(active_config)

    Set the config to use for this worktree. Should match a build config name.

  `check_unique_name`(new_project)

    Check Unique Name

Changelog CMake index Python index Index