From 7b2b895db21e57cf83645caf908cca6cf320c6b1 Mon Sep 17 00:00:00 2001 From: "ChangBo Guo(gcb)" Date: Mon, 14 Dec 2015 16:05:09 +0800 Subject: [PATCH] Add missing doc index for imageutils and fnmatch We added these two modules recently, but didn't include them in doc index. This commit add them in doc index and add version information about when they were added. Change-Id: Ic3347f57a722187fc4bfe68fce6f08fba97af7fb --- doc/source/index.rst | 2 ++ oslo_utils/fnmatch.py | 2 ++ oslo_utils/imageutils.py | 8 ++++++++ 3 files changed, 12 insertions(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index 9f00c105..0262d63f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,6 +23,8 @@ API Documentation api/excutils api/fileutils api/fixture + api/fnmatch + api/imageutils api/importutils api/netutils api/reflection diff --git a/oslo_utils/fnmatch.py b/oslo_utils/fnmatch.py index 8dd7aa02..d19f55e1 100644 --- a/oslo_utils/fnmatch.py +++ b/oslo_utils/fnmatch.py @@ -15,6 +15,8 @@ Standard library fnmatch in Python versions <= 2.7.9 has thread safe issue, this module is created for such case. see: https://bugs.python.org/issue23191 + +.. versionadded:: 3.3 """ from __future__ import absolute_import diff --git a/oslo_utils/imageutils.py b/oslo_utils/imageutils.py index b829abd6..245a384b 100644 --- a/oslo_utils/imageutils.py +++ b/oslo_utils/imageutils.py @@ -17,6 +17,8 @@ """ Helper methods to deal with images. + +.. versionadded:: 3.1 """ import re @@ -26,6 +28,12 @@ from oslo_utils import strutils class QemuImgInfo(object): + """Parse Qemu image information from command `qemu-img info`'s output. + + The instance of :class:`QemuImgInfo` has properties: `image`, + `backing_file`, `file_format`, `virtual_size`, `cluster_size`, + `disk_size`, `snapshots` and `encrypted`. + """ BACKING_FILE_RE = re.compile((r"^(.*?)\s*\(actual\s+path\s*:" r"\s+(.*?)\)\s*$"), re.I) TOP_LEVEL_RE = re.compile(r"^([\w\d\s\_\-]+):(.*)$")