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_migrator.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'cloudinit/config/cc_migrator.py') diff --git a/cloudinit/config/cc_migrator.py b/cloudinit/config/cc_migrator.py index facaa538..6e0bf4bb 100644 --- a/cloudinit/config/cc_migrator.py +++ b/cloudinit/config/cc_migrator.py @@ -16,6 +16,28 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Migrator +-------- +**Summary:** migrate old versions of cloud-init data to new + +This module handles moving old versions of cloud-init data to newer ones. +Currently, it only handles renaming cloud-init's per-frequency semaphore files +to canonicalized name and renaming legacy semaphore names to newer ones. This +module is enabled by default, but can be disabled by specifying ``migrate: +false`` in config. + +**Internal name:** ``cc_migrator`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + migrate: +""" + import os import shutil -- cgit v1.2.3