From 1071b9940b4e114cd2eabf290b739f92fbab33de Mon Sep 17 00:00:00 2001 From: Wesley Wiedenmeier Date: Sun, 28 Aug 2016 17:56:17 -0500 Subject: Improve module documentation and doc cleanup. This adds lots of config module documentation in a standard format. It will greatly improve the content at readthedocs. Additionally: * Add a 'doc' env to tox.ini * Changed default highlight language for sphinx conf from python to yaml most examples in documentation are yaml configs * Updated datasource examples to highlight sh code properly --- cloudinit/config/cc_scripts_user.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'cloudinit/config/cc_scripts_user.py') diff --git a/cloudinit/config/cc_scripts_user.py b/cloudinit/config/cc_scripts_user.py index 699857d1..54338a43 100644 --- a/cloudinit/config/cc_scripts_user.py +++ b/cloudinit/config/cc_scripts_user.py @@ -18,6 +18,25 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Scripts User +------------ +**Summary:** run user scripts + +This module runs all user scripts. User scripts are not specified in the +``scripts`` directory in the datasource, but rather are present in the +``scripts`` dir in the instance configuration. Any cloud-config parts with a +``#!`` will be treated as a script and run. Scripts specified as cloud-config +parts will be run in the order they are specified in the configuration. +This module does not accept any config keys. + +**Internal name:** ``cc_scripts_user`` + +**Module frequency:** per instance + +**Supported distros:** all +""" + import os from cloudinit import util -- cgit v1.2.3