diff options
author | Davanum Srinivas <dims@linux.vnet.ibm.com> | 2014-07-31 22:14:09 -0400 |
---|---|---|
committer | Davanum Srinivas (dims) <davanum@gmail.com> | 2014-08-08 22:07:04 +0000 |
commit | 07c9c1ba3ae310b725112804dbc2398630ec27a5 (patch) | |
tree | 9aa141cb9b9289e7e779729f0115d489f601ce7c /nova/virt/vmwareapi/ds_util.py | |
parent | 168484aba7acb31e69ce3bfecf5b145c13e71f15 (diff) | |
download | nova-07c9c1ba3ae310b725112804dbc2398630ec27a5.tar.gz |
docs - Fix docstring issues in virt tree
Fix the following errors in several files.
ERROR: Unexpected indentation.
ERROR: Unknown interpreted text role "paramref".
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: Definition list ends without a blank line; unexpected unindent.
WARNING: Enumerated list ends without a blank line; unexpected unindent.
WARNING: Field list ends without a blank line; unexpected unindent.
Specifically the "Unknown interpreted text role" was fixed by adding
a separate import instead of importing 'text' directly. Others were
indentation, new lines, or adding lists.
Change-Id: I241ce1ca9831d9df00d022297ea622953a6fdc60
Diffstat (limited to 'nova/virt/vmwareapi/ds_util.py')
-rw-r--r-- | nova/virt/vmwareapi/ds_util.py | 42 |
1 files changed, 23 insertions, 19 deletions
diff --git a/nova/virt/vmwareapi/ds_util.py b/nova/virt/vmwareapi/ds_util.py index 8db0e665b0..1cf523a917 100644 --- a/nova/virt/vmwareapi/ds_util.py +++ b/nova/virt/vmwareapi/ds_util.py @@ -94,12 +94,14 @@ class DatastorePath(object): file path to a virtual disk. Note: - - Datastore path representations always uses forward slash as separator + + * Datastore path representations always uses forward slash as separator (hence the use of the posixpath module). - - Datastore names are enclosed in square brackets. - - Path part of datastore path is relative to the root directory + * Datastore names are enclosed in square brackets. + * Path part of datastore path is relative to the root directory of the datastore, and is always separated from the [ds_name] part with a single space. + """ VMDK_EXTENSION = "vmdk" @@ -338,22 +340,24 @@ def file_move(session, dc_ref, src_file, dst_file): The list of possible faults that the server can return on error include: - - CannotAccessFile: Thrown if the source file or folder cannot be - moved because of insufficient permissions. - - FileAlreadyExists: Thrown if a file with the given name already - exists at the destination. - - FileFault: Thrown if there is a generic file error - - FileLocked: Thrown if the source file or folder is currently - locked or in use. - - FileNotFound: Thrown if the file or folder specified by sourceName - is not found. - - InvalidDatastore: Thrown if the operation cannot be performed on - the source or destination datastores. - - NoDiskSpace: Thrown if there is not enough space available on the - destination datastore. - - RuntimeFault: Thrown if any type of runtime fault is thrown that - is not covered by the other faults; for example, - a communication error. + + * CannotAccessFile: Thrown if the source file or folder cannot be + moved because of insufficient permissions. + * FileAlreadyExists: Thrown if a file with the given name already + exists at the destination. + * FileFault: Thrown if there is a generic file error + * FileLocked: Thrown if the source file or folder is currently + locked or in use. + * FileNotFound: Thrown if the file or folder specified by sourceName + is not found. + * InvalidDatastore: Thrown if the operation cannot be performed on + the source or destination datastores. + * NoDiskSpace: Thrown if there is not enough space available on the + destination datastore. + * RuntimeFault: Thrown if any type of runtime fault is thrown that + is not covered by the other faults; for example, + a communication error. + """ LOG.debug("Moving file from %(src)s to %(dst)s.", {'src': src_file, 'dst': dst_file}) |