The diagrams in this guide and in the module guides are generated from the PlantUML sources in each application's diagrams/ folder, for example docs/applications/ppp/diagrams/, which describe the implementation as it is. They use the following conventions:
| Notation | Meaning |
|---|---|
entry / action and exit / action |
An action performed by the state's entry or exit function |
EVENT / action |
An action performed when the state handles EVENT, without leaving the state |
EVENT / ; |
An event the state deliberately handles by doing nothing, so that it does not propagate to the parent state |
EVENT [guard] on a transition |
A transition taken only when the guard holds |
| Dashed state or transition | Present only in some build configurations. The Kconfig symbol is named in the state |
To change a diagram, edit its .puml file and regenerate the .svg with scripts/render_diagrams.py, as described in CI and contribution.