bmaptools: amend commentaries about file-like objects
authorArtem Bityutskiy <artem.bityutskiy@intel.com>
Mon, 6 May 2013 12:11:20 +0000 (15:11 +0300)
committerArtem Bityutskiy <artem.bityutskiy@intel.com>
Mon, 6 May 2013 14:58:51 +0000 (17:58 +0300)
In some places we require true file objects, i.e., they should be backed by
real files. However, comments just tell about file-like objects. Amend the
comments.

Change-Id: I90934f18558c6e9e8706c7cd62702c301099283d
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
bmaptools/BmapCopy.py
bmaptools/BmapCreate.py

index a3bc840c19fc1f60247647b3c28df36e54c6ef20..af550066bc78e12aabaf71eb59c42f5784a8d439 100644 (file)
@@ -59,8 +59,8 @@ class BmapCopy:
     the following:
 
     * full path or a file-like object of the image to copy
-    * full path or a file-like object of the destination file copy the image to
-    * full path or a file-like object of the bmap file (optional)
+    * full path or a file object of the destination file copy the image to
+    * full path or a file object of the bmap file (optional)
     * image size in bytes (optional)
 
     Although the main purpose of this class is to use bmap, the bmap is not
@@ -177,9 +177,9 @@ class BmapCopy:
             image      - file-like object of the image which should be copied,
                          should only support 'read()' and 'seek()' methods,
                          and only seeking forward has to be supported.
-            dest       - file-like object of the destination file to copy the
-                         image to.
-            bmap       - file-like object of the bmap file to use for copying.
+            dest       - file object of the destination file to copy the image
+                         to.
+            bmap       - file object of the bmap file to use for copying.
             image_size - size of the image in bytes. """
 
         self._xml = None
index 6e53c81bb407513e02bfafe6e03ca88548f4d7d3..34619c6cae619470e89387e1c8e0eaacd7f7d5ba 100644 (file)
@@ -88,7 +88,7 @@ class BmapCreate:
     create an instance of 'BmapCreate' and provide:
 
     * full path or a file-like object of the image to create bmap for
-    * full path or a file-like object to use for writing the results to
+    * full path or a file object to use for writing the results to
 
     Then you should invoke the 'generate()' method of this class. It will use
     the FIEMAP ioctl to generate the bmap. """
@@ -119,8 +119,8 @@ class BmapCreate:
         """ Initialize a class instance:
         * image - full path or a file-like object of the image to create bmap
                   for
-        * bmap  - full path or a file-like object to use for writing the
-                  resulting bmap to """
+        * bmap  - full path or a file object to use for writing the resulting
+                  bmap to """
 
         self.image_size = None
         self.image_size_human = None