openstack/cinder
Code Issues Proposed changes

Fix doc comments

Browse Source 
Fixing typos in driver interface doc comments.

TrivialFix

Change-Id: Ia402409a4f662b722c1b253f761aa0bc51760df7
This commit is contained in:
Vipin Balachandran 2016-07-22 14:02:25 +05:30
parent 84e4c2b220
commit 609ce1fe6b
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cinder/interface/backup_chunked_driver.py
View File

@ -58,7 +58,7 @@ class BackupChunkedDriver(backup_driver.BackupDriver):
"""Delete object from container. """Delete object from container.
:param container: The container to modify. :param container: The container to modify.
:param object_name: The object name delete. :param object_name: The object name to delete.
""" """
def update_container_name(self, backup, container): def update_container_name(self, backup, container):
@ -75,5 +75,7 @@ class BackupChunkedDriver(backup_driver.BackupDriver):
This method allows for collection of extra metadata in prepare_backup() This method allows for collection of extra metadata in prepare_backup()
which will be passed to get_object_reader() and get_object_writer(). which will be passed to get_object_reader() and get_object_writer().
Subclass extensions can use this extra information to optimize Subclass extensions can use this extra information to optimize
data transfers. Return a json serializable object. data transfers.
:returns: json serializable object
""" """

15
cinder/interface/backup_driver.py
View File

@ -52,9 +52,9 @@ class BackupDriver(base.CinderInterface):
"""Start a backup of a specified volume. """Start a backup of a specified volume.
If backup['parent_id'] is given, then an incremental backup If backup['parent_id'] is given, then an incremental backup
should be performed is supported. should be performed.
If the parent backup is a different size, a full backup should be If the parent backup is of different size, a full backup should be
performed to ensure all data is included. performed to ensure all data is included.
TODO(smcginnis) Document backup variable structure. TODO(smcginnis) Document backup variable structure.
@ -66,7 +66,7 @@ class BackupDriver(base.CinderInterface):
""" """
def restore(self, backup, volume_id, volume_file): def restore(self, backup, volume_id, volume_file):
"""Restore data from a backup. """Restore volume from a backup.
:param backup: The backup information. :param backup: The backup information.
:param volume_id: The volume to be restored. :param volume_id: The volume to be restored.
@ -83,9 +83,8 @@ class BackupDriver(base.CinderInterface):
"""Export driver specific backup record information. """Export driver specific backup record information.
If backup backend needs additional driver specific information to If backup backend needs additional driver specific information to
import backup record back into the system it must overwrite this method import backup record back into the system it must override this method
and return it here as a dictionary so it can be serialized into a and return it as a dictionary so it can be serialized into a string.
string.
Default backup driver implementation has no extra information. Default backup driver implementation has no extra information.
@ -97,7 +96,7 @@ class BackupDriver(base.CinderInterface):
"""Import driver specific backup record information. """Import driver specific backup record information.
If backup backend needs additional driver specific information to If backup backend needs additional driver specific information to
import backup record back into the system it must overwrite this method import backup record back into the system it must override this method
since it will be called with the extra information that was provided by since it will be called with the extra information that was provided by
export_record when exporting the backup. export_record when exporting the backup.
@ -107,5 +106,5 @@ class BackupDriver(base.CinderInterface):
:param backup: backup object to export :param backup: backup object to export
:param driver_info: dictionary with driver specific backup record :param driver_info: dictionary with driver specific backup record
information information
:returns: nothing :returns: None
""" """