From d03a8cc932b2f08d1f518134f786c4d1a3f71522 Mon Sep 17 00:00:00 2001 From: Anton Arefiev Date: Mon, 20 Mar 2017 15:24:59 +0200 Subject: [PATCH] Mention state machine diagram generation in contrib guide Change-Id: I92cd5eb5d503c8294c30c22eab2b01899e2d5d88 --- CONTRIBUTING.rst | 5 +++++ doc/source/workflow.rst | 2 ++ 2 files changed, 7 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 340b4a24d..18a0c8748 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -68,6 +68,11 @@ To run the functional tests, use:: tox -e func +Once you have added new state or transition into inspection state machine, you +should regenerate :ref:`state_machine_diagram` with:: + + tox -e genstates + Run the service with:: .tox/py27/bin/ironic-inspector --config-file example.conf diff --git a/doc/source/workflow.rst b/doc/source/workflow.rst index dbf9a33c8..43ea96238 100644 --- a/doc/source/workflow.rst +++ b/doc/source/workflow.rst @@ -56,6 +56,8 @@ Usual hardware introspection flow is as follows: Starting DHCP server and configuring PXE boot environment is not part of this package and should be done separately. +.. _state_machine_diagram: + State machine diagram =====================