Worktree and projects

Every tool is using a worktree.

The WorkTree class contains just a list of paths, which are simple Project objects. Those do not have a name, and are identified by there relative path to the worktree. They are stored in a worktree cache, in <worktree root>/.qi/worktree.xml

<worktree>
|__ .qi
    |__ worktree.xml
|__ foo
|__ bar
    |__ baz

Here for instance you could have two projects: one in foo, and the other in bar

Projects are added to the worktree with qisrc add, qisrc remove, but the `

Projects can also contain sub-projects, providing they have a qiproject.xml at their root:

<!-- in bar/qiproject.xml -->
<project>
  <project src="baz" />
</project>

Here, if the bar path is registered to the worktree and bar/baz exists, then a project in bar/baz will be created too

Using the worktree with a qiBuild tool

Then, other classes creates their own kind of projects using the registered paths in the worktree.

For instance, to have a buildable project, you must have

  • a <qibuild> tag in qiproject.xml
  • a CMakeLists.txt file next to the qiproject.xml

So the list of buildable paths (from where you can run CMake) is always a sublist of all the projects in the worktree.

Buildable projects are then identified by their names, which must be unique in the worktree.

This makes it possible to express dependencies between buildable projects using just the names, and not caring where the build projects are actually located on the filesystem

It also means you can nest qibuild and qidoc projects anyway you want.

For instance:

  • a build project at the root in <worktree>/foo, with the doc in <worktree>/foo/doc
<!-- in foo/qiproject.xml -->
<project>
  <qibuild name="foo" />
  <project src="doc" />
</project>

<!-- in foo/doc/qiproject.xml -->

<project>
  <qidoc name="foo" type="shinx" />
</project>
  • Two build projects in the same git project:
<!-- in worktree/top/qiproject.xml -->
<project>
  <project src="hello" />
  <project src="world" />
<project>

<!-- in worktree/top/hello/qiproject.xml -->
<project>
  <qibuild name="hello" />
</project>

<!-- in worktree/top/world/qiproject.xml -->
<project>
  <qibuild name="world" />
</project>
« previous | up | next »