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_debug.py | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) (limited to 'cloudinit/config/cc_debug.py') diff --git a/cloudinit/config/cc_debug.py b/cloudinit/config/cc_debug.py index bdc32fe6..5ab36469 100644 --- a/cloudinit/config/cc_debug.py +++ b/cloudinit/config/cc_debug.py @@ -15,22 +15,28 @@ # along with this program. If not, see . """ +Debug +----- **Summary:** helper to debug cloud-init *internal* datastructures. -**Description:** This module will enable for outputting various internal -information that cloud-init sources provide to either a file or to the output -console/log location that this cloud-init has been configured with when -running. +This module will enable for outputting various internal information that +cloud-init sources provide to either a file or to the output console/log +location that this cloud-init has been configured with when running. -It can be configured with the following option structure:: +.. note:: + Log configurations are not output. - debug: - verbose: (defaulting to true) - output: (location to write output, defaulting to console + log) +**Internal name:** ``cc_debug`` -.. note:: +**Module frequency:** per instance - Log configurations are not output. +**Supported distros:** all + +**Config keys**:: + + debug: + verbose: true/false (defaulting to true) + output: (location to write output, defaulting to console + log) """ import copy -- cgit v1.2.3