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_update_hostname.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'cloudinit/config/cc_update_hostname.py') diff --git a/cloudinit/config/cc_update_hostname.py b/cloudinit/config/cc_update_hostname.py index 5b78afe1..315b7b6f 100644 --- a/cloudinit/config/cc_update_hostname.py +++ b/cloudinit/config/cc_update_hostname.py @@ -18,6 +18,31 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Update Hostname +--------------- +**Summary:** update hostname and fqdn + +This module will update the system hostname and fqdn. If ``preserve_hostname`` +is set, then the hostname will not be altered. + +.. note:: + for instructions on specifying hostname and fqdn, see documentation for + ``cc_set_hostname`` + +**Internal name:** ``cc_update_hostname`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + preserve_hostname: + fqdn: + hostname: +""" + import os from cloudinit.settings import PER_ALWAYS -- cgit v1.2.3