LimitationΒΆ

If you want to point out a limitation in the Bareos functionality, the following formatting should be used:

.. limitation:: <Component>: <Short description>

   Long description,
   can contain multiple lines.

Besides showing this text, the limitation markup will also create indices.

The short description should be as short as possible, as it will get part of the index.

Example:

.. limitation:: Style Guide: Example

   This is not a real limitation, but only a Style Guide example.
   The description can contain multiple lines.

This will be displayed as:

Limitation - Style Guide: Example

This is not a real limitation, but only a Style Guide example. The description can contain multiple lines.