Add note to BasicIo docs about planned removal

Author: jim-easterbrook

src/interface/basicio.i

@@ -23,6 +23,17 @@
     "Class interface to access files, memory and remote data.";
 #endif
 
+%feature("docstring") Exiv2::BasicIo "An interface for simple binary IO.
+
+This appears to be mainly for use internally by libexiv2, apart from
+accessing data with the mmap() and munmap() methods. Since v0.18.0
+python-exiv2 has an Image.data() method to provide data access without
+going via a Python BasicIo object.
+
+It is planned to remove BasicIo from the Python interface in a future
+release. Please let me ([email protected]) know if that wiould
+be a problem for you.";
+
 #pragma SWIG nowarn=321 // 'open' conflicts with a built-in name in python
 
 %include "shared/preamble.i"

src/swig-0_27_7/basicio_wrap.cxx

@@ -6034,9 +6034,14 @@ static PyHeapTypeObject SwigPyBuiltin__Exiv2__BasicIo_type = {
     "\n"
 		"An interface for simple binary IO.\n"
 		"\n"
-		"Designed to have semantics and names similar to those of C style FILE*\n"
-		"operations. Subclasses should all behave the same so that they can be\n"
-		"interchanged.\n"
+		"This appears to be mainly for use internally by libexiv2, apart from\n"
+		"accessing data with the mmap() and munmap() methods. Since v0.18.0\n"
+		"python-exiv2 has an Image.data() method to provide data access without\n"
+		"going via a Python BasicIo object.\n"
+		"\n"
+		"It is planned to remove BasicIo from the Python interface in a future\n"
+		"release. Please let me ([email protected]) know if that wiould\n"
+		"be a problem for you.\n"
 		"", /* tp_doc */
     (traverseproc) 0,                       /* tp_traverse */
     (inquiry) 0,                            /* tp_clear */
@@ -6245,9 +6250,14 @@ static PyTypeObject *SwigPyBuiltin__Exiv2__BasicIo_type_create(PyTypeObject *typ
     { Py_tp_doc,                        (void *)"\n"
 		"An interface for simple binary IO.\n"
 		"\n"
-		"Designed to have semantics and names similar to those of C style FILE*\n"
-		"operations. Subclasses should all behave the same so that they can be\n"
-		"interchanged.\n"
+		"This appears to be mainly for use internally by libexiv2, apart from\n"
+		"accessing data with the mmap() and munmap() methods. Since v0.18.0\n"
+		"python-exiv2 has an Image.data() method to provide data access without\n"
+		"going via a Python BasicIo object.\n"
+		"\n"
+		"It is planned to remove BasicIo from the Python interface in a future\n"
+		"release. Please let me ([email protected]) know if that wiould\n"
+		"be a problem for you.\n"
 		"" },
     { Py_tp_repr,                       (void *)(reprfunc) 0 },
     { Py_tp_str,                        (void *)(reprfunc) 0 },

src/swig-0_28_7/basicio_wrap.cxx

@@ -6301,9 +6301,14 @@ static PyHeapTypeObject SwigPyBuiltin__Exiv2__BasicIo_type = {
     "\n"
 		"An interface for simple binary IO.\n"
 		"\n"
-		"Designed to have semantics and names similar to those of C style FILE*\n"
-		"operations. Subclasses should all behave the same so that they can be\n"
-		"interchanged.\n"
+		"This appears to be mainly for use internally by libexiv2, apart from\n"
+		"accessing data with the mmap() and munmap() methods. Since v0.18.0\n"
+		"python-exiv2 has an Image.data() method to provide data access without\n"
+		"going via a Python BasicIo object.\n"
+		"\n"
+		"It is planned to remove BasicIo from the Python interface in a future\n"
+		"release. Please let me ([email protected]) know if that wiould\n"
+		"be a problem for you.\n"
 		"", /* tp_doc */
     (traverseproc) 0,                       /* tp_traverse */
     (inquiry) 0,                            /* tp_clear */
@@ -6512,9 +6517,14 @@ static PyTypeObject *SwigPyBuiltin__Exiv2__BasicIo_type_create(PyTypeObject *typ
     { Py_tp_doc,                        (void *)"\n"
 		"An interface for simple binary IO.\n"
 		"\n"
-		"Designed to have semantics and names similar to those of C style FILE*\n"
-		"operations. Subclasses should all behave the same so that they can be\n"
-		"interchanged.\n"
+		"This appears to be mainly for use internally by libexiv2, apart from\n"
+		"accessing data with the mmap() and munmap() methods. Since v0.18.0\n"
+		"python-exiv2 has an Image.data() method to provide data access without\n"
+		"going via a Python BasicIo object.\n"
+		"\n"
+		"It is planned to remove BasicIo from the Python interface in a future\n"
+		"release. Please let me ([email protected]) know if that wiould\n"
+		"be a problem for you.\n"
 		"" },
     { Py_tp_repr,                       (void *)(reprfunc) 0 },
     { Py_tp_str,                        (void *)(reprfunc) 0 },