diff options
author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
---|---|---|
committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /cloudinit/config/cc_debug.py | |
parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip |
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
Diffstat (limited to 'cloudinit/config/cc_debug.py')
-rw-r--r-- | cloudinit/config/cc_debug.py | 26 |
1 files changed, 16 insertions, 10 deletions
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 <http://www.gnu.org/licenses/>. """ +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 |