aegstate5

Usage

Overview

The aegis state file is used to store the pointers to project directories.

Contents

where = [{ ... }];

This field is a table relating project name to project directory. The structure is as follows:

project_name = string;

The name of a project.

directory = string;

Absolute path of the project's directory. (Only set of alias_for is not set.)

alias_for = string;

This is the name of another project, possibly including branch numbers. It allows you to have shorter or more meaningful project names. (Only set if directory is not set.)

Writing report scripts

When attempting to access these fields from within the report generator, you need a code fragment similar to the following:

auto p;
p = project[project_name()];

That is, the where field is represented by the project array variable, however, it does not mention the aliases, only the actual projects, similar to the “ael projects” command. (You can, however, index the projects array by an alias, or even by a project name with branches on the end.)

In addition to the project_name and directory fields specified above, the report generator insets a state field, which gives you access to the project state fields (see aepstate(5) for more information).