JobLimit

Restricts concurrent execution of jobs in a given pool. More...

• List of all members, including inherited members
• JobLimit is part of List of All Items.

Properties

• condition : bool
• jobCount : int
• jobPool : string

Detailed Description

In addition to the global limit on concurrently running commands, a project might want to restrict concurrent execution of certain types of commands even further, for instance because they are not well-suited to share certain types of resources.

In the following example, we define a rule that runs a tool of which at most one instance can be running for the same project at any given time:

Rule {
    // ...
    prepare: {
        var cmd = new Command("my-exclusive-tool", [project.buildDirectory]);
        cmd.description = "running the exclusive tool";
        cmd.jobPool = "exclusive_tool";
        return cmd;
    }
}
JobLimit {
    jobPool: "exclusive_tool"
    jobCount: 1
}

JobLimit items can appear inside Product, Project and Module items. In the case of collisions, that is, items matching the same job pool but setting different values, the ones defined inside products have the highest precedence, and the ones inside modules have the lowest. Items defined in sub-projects have higher precedence than those defined in parent projects. For items with the same precedence level, the most restrictive one is chosen, that is, the one with the lowest job number greater than zero.

See also How do I limit the number of concurrent jobs for the linker only?.

Property Documentation

Group Module