Enhance engines docs

Add a note about formatting to make it more clear.
This commit is contained in:
Mike Place 2017-09-18 13:44:44 -06:00
parent e29efecf4f
commit 1a619708c1

View File

@ -27,7 +27,12 @@ Salt engines are configured under an ``engines`` top-level section in your Salt
port: 5959 port: 5959
proto: tcp proto: tcp
Salt engines must be in the Salt path, or you can add the ``engines_dirs`` option in your Salt master configuration with a list of directories under which Salt attempts to find Salt engines. Salt engines must be in the Salt path, or you can add the ``engines_dirs`` option in your Salt master configuration with a list of directories under which Salt attempts to find Salt engines. This option should be formatted as a list of directories to search, such as:
.. code-block:: yaml
engines_dirs:
- /home/bob/engines
Writing an Engine Writing an Engine
================= =================