Add warning about using dots in ID declaration

This commit is contained in:
Erik Johnson 2012-01-29 18:51:57 -06:00
parent a6bd7e0213
commit a475787f41
2 changed files with 6 additions and 0 deletions

View File

@ -59,6 +59,9 @@ ID declaration
Occurs on the top level or under the :term:`extend declaration`.
Must **not** contain a dot, otherwise highstate summary output will be
unpredictable.
Extend declaration
------------------

View File

@ -81,6 +81,9 @@ In this case it defines the name of the package to be installed. **NOTE:** the
package name for the Apache httpd web server may differ on your OS or distro —
for example, on Fedora it is ``httpd`` but on Debian/Ubuntu it is ``apache2``.
Additionally, an ID declaration should not contain a dot, as this will produce
unpredictable output in the summary returned from a highstate.
The second line, called the :term:`state declaration`, defines which of the
Salt States we are using. In this example, we are using the :mod:`pkg state
<salt.states.pkg>` to ensure that a given package is installed.