[Documentation] [TitleIndex] [WordIndex

DO NOT READ, THIS IS A WORK IN PROGRESS

rosdistro is a file format for managing ROS Distributions and the ROS Stacks they contain. This file format is used as input to a variety of tools in the ROS build and release toolchain, from stack release tools to rosdoc.

UNSTABLE DOCUMENTATION

rosdistro.yaml

The rosdistro file format is a YAML-based description of a collection of ROS stacks.

This file format has several main sections:

variants

The variants section lists groupings of stacks that you wish to install together. They map directly to debian metapackages.

stacks

Each key in the stacks section describes information about a particular stack, e.g.

  mystack: {version: 0.7.3}

In this example, the stack is named mystack. It has a version 0.7.3 release associated with the latest distribution. Additional keys for other distributions can be added.

Each stack property list may also contain a _rules key, which overrides any higher-level _rules values.

_rules

_rules are URL format strings that are used for determining the location of source code related to a stack.

There are two types of _rules allowed in a rosdistro file. The top-level rules section is a dictionary with named rule entries. You can also put a _rules entry at any level of the stacks entry. This lower-level _rules entry can either contain a rules list, or it can refer to a top-level `_rules entry by name.

For a description of the _rules format, please see the rules page.


2022-05-28 12:57