[DOC] add warning about the dangers of doing salt-call state.highstate on your own machine (closes #149103)

authorPaul Tonelli <paul.tonelli@logilab.fr>
changesete53cbed31fd3
branchdefault
phasepublic
hiddenno
parent revision#54aa6205c9a4 [docs] cosmetic fixes
child revision#d6b522b1315f add top-level schema of SACB (closes #144255) and option to compile it
files modified by this revision
README.rst
docs/how-it-works.rst
# HG changeset patch
# User Paul Tonelli <paul.tonelli@logilab.fr>
# Date 1372327012 -7200
# Thu Jun 27 11:56:52 2013 +0200
# Node ID e53cbed31fd355b10d739d0fe8fee701ddbf8941
# Parent 54aa6205c9a42f33ff926fc25c9636eaee319857
[DOC] add warning about the dangers of doing salt-call state.highstate on your own machine (closes #149103)

diff --git a/README.rst b/README.rst
@@ -81,10 +81,14 @@
1 
2      sudo salt-call saltutil.sync_modules
3      sudo salt-call saltutil.sync_states
4      sudo salt-call state.sls ami_builder
5 
6 +.. WARNING::
7 +    At this point, do NOT run a highstate  (salt-call state.highstate), as this
8 +    would modify multiple important system files from your system.
9 +
10  If you got only green and blue outputs, everything should be ok.
11 
12  You are now the proud owner of a variation.img file containing your
13  dear AMI, in `/mnt/output`.
14 
diff --git a/docs/how-it-works.rst b/docs/how-it-works.rst
@@ -16,10 +16,15 @@
15  file by passing it as argument.
16 
17  The next step updates the salt states, if necessary by getting the necessary
18  files from the mercurial (hg) repository
19 
20 +.. WARNING::
21 +  The following commands replace the /etc/rc.local file on the machine as well as a few other
22 +  files (see the update.sls state file for more information), so do NOT do this
23 +  on your main machine !
24 +
25  .. code-block:: bash
26 
27    salt-call state.highstate
28    salt-call state.highstate
29