Docs for 3.0 release

FirebirdSQL · Sep 3, 2024 · e81f641 · e81f641
1 parent aea5119
commit e81f641
Show file tree

Hide file tree

Showing 4 changed files with 136 additions and 2 deletions.
diff --git a/Builds/Gcc.lin/readme.linux b/Builds/Gcc.lin/readme.linux
@@ -1,3 +1,19 @@
+====== ODBC v3.0 driver notes ======================================
+
+Version 3.0 has no significant changes to the build sequence compared to the previous version.
+However, to build from source, you should use C++17.
+
+How to build:
+ * Move to Builds/gcc.lin
+ * Rename makefile.linux -> makefile
+ * Provide the correct path to your Firebird installation (FIREBIRD var)
+ * Set the DEBUG var if you need a debug build
+ * Run `make`
+ * Your libraries are in ./Release_<arch> or ./Debug_<arch> folder.
+
+===
+
+
 1)==================================================================
   For connect from unixODBC :
 

diff --git a/ChangeLog_v3.0 b/ChangeLog_v3.0
@@ -0,0 +1,33 @@
+
+ * OOAPI implemented
+   Related to this entire release
+
+ * Power BI problem, I think that is ODBC Driver.
+   #216 by hamacker was closed on Feb 16
+
+ * DECFLOAT not support
+   #214 by Zeki-Gursoy was closed on Feb 21
+
+ * Windows defender warns malware in installers.zip
+   #212 by tomneko was closed on Jan 17
+
+ * Installer does not overwrite older DLLs
+   #211 by jabrugger was closed on Dec 28, 2023
+
+ * Cannot link tables using MS Access
+   #210 by jabrugger was closed on Dec 26, 2023
+
+ * SUBSTRING in ODBC escape translations
+   #207 by edwig was closed on Feb 12
+
+ * ODBC - Firebird 4 affect-version: 3.0 Beta resolution: fixed
+   #205 by Uzytkownik111 was closed on Feb 29
+
+ * Configuration switch for WireCompression affect-version: 3.0 Beta enhancement priority: minor
+   #204 by MartinKoeditz was closed on Sep 03
+
+ * SQLTables error where table name is over 31 characters affect-version: 3.0 Beta resolution: fixed
+   #202 by faridzidan was closed on Feb 29
+
+ * SQLGetData with zero-length BLOB affect-version: 3.0 Beta resolution: fixed
+   #201 by aafemt was closed on Feb 29
diff --git a/Install/ReleaseNotes_v3.0.html b/Install/ReleaseNotes_v3.0.html
@@ -0,0 +1,84 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta content="text/html; charset=iso-8859-1">
+<meta name="Author" content="Yuri Nikolaev">
+<style type="text/css">
+BODY  {
+  color: black;  background-color: white;  font-family:  Lucida, Verdana, Helvetica, Arial, sans-serif;
+  font-style:   normal; font-variant: normal; font-weight:  normal;  font-size:    100%; width:  auto;
+  }
+
+H6, TD H6  { font-size: xx-small; font-weight: bold; font-variant: small-caps;  }
+H5, TD H5  { font-size: x-small;  font-weight: bold; font-variant: small-caps; }
+H4, TD H4  { font-size: small;    font-weight: bold; font-variant: small-caps;  }
+H3, TD H3  { font-size: medium;   font-weight: bold; }
+H2, TD H2  { font-size: large;    font-weight: bold; }
+
+H5.red, TD H5.red { font-size: x-small;  font-weight: bold;  color: red; font-variant: small-caps;}
+H4.red, TD H4.red {font-size: small;     font-weight: bold;  color: red; font-variant: small-caps;    }
+H3.red, TD H3.red { font-size: medium; font-weight: bold;  color: red; }
+
+H5.green, TD H5.green { font-size: x-small;  font-weight: bold;  color: #006600; font-variant: small-caps;}
+H4.green, TD H4.green {font-size: small;     font-weight: bold;  color: #006600; font-variant: small-caps;    }
+H3.green, TD H3.green { font-size: medium; font-weight: bold;  color: #006600; }
+
+OL, OL OL, LI, LI LI  { font-size: x-small; text-align: left; list-style-type: decimal; }
+UL, LI, LI LI { text-indent: 0%;    list-style-type: disc; font-size: small; }
+LI.plain, LI LI.plain { font-size: small; list-style: none; }
+
+TT, PRE, CODE, LI.code, LI LI.code { font-size: x-small; font-family: "Courier New"; }
+
+P, TD, TD P, CAPTION {  font-family:  Lucida, Verdana, Helvetica, Arial, sans-serif; font-size: medium; text-align: left; }
+P.smallcaps{ font-variant: small-caps; }
+
+.strongstyle {  font-weight: bold; }
+.warning { font-weight: bolder; text-transform: none; background: yellow; }
+
+A { font-size: medium;     text-decoration: underline;  }
+A:link { color:	Blue; } A:visited { color:	gray; } A:active { color:	red; }
+A:hover { color: red; } A.offsite {	color:	blue; }
+
+</style>
+</head>
+<body>
+<a NAME="top"></a>
+<h2>The Firebird ODBC driver v3.0</h2>
+<p>&nbsp;
+
+<p>This version is a rework of v2 to implement modern FB OOAPI inside an ODBC driver. In addition it contains
+a fixpack for many known issues, see ../ChangeLog_v3.0 for details.
+<p>Please note that v3.0 driver is guaranteed to work only with Firebird clients 3.0 and later.
+   If you have fbclient.dll from 2.5 or some older version, it may be incompatible.
+
+<p>&nbsp;
+
+<p>The Windows build is adapted to a modern VS, the project is located in Builds/MsVc2022.win folder 
+and can be opened/compiled with VS2022 or later.
+<p>The Windows build key features are:
+<ul>
+	<li>Dll name was changed to FirebirdODBC.dll;</li>
+	<li>Driver name was changed to "Firebird ODBC Driver";</li>
+	<li>The new driver will be installed in a separate folder ({Program Files}\Firebird\Firebird_ODBC_3 actually) and can be safely uninstalled if necessary.
+        So, if you want to create a DSN using the new driver edition, you should select "Firebird ODBC Driver". Your DSNs associated with the current driver version ("Firebird/Interbase(r) driver") will continue to work and will not be affected by installing a new driver.</li>
+</ul>
+You can see the details at <a href="https://github.com/FirebirdSQL/firebird-odbc-driver/wiki">https://github.com/FirebirdSQL/firebird-odbc-driver/wiki</a>
+
+<p>&nbsp;
+
+<p>The Linux build is located in Builds/Gcc.lin folder, see Builds/Gcc.lin/readme.linux for details.
+
+<p>&nbsp;
+
+<p>Hope you have no problems with this release. However, you can always request support at 
+<a href="https://github.com/FirebirdSQL/firebird-odbc-driver/issues">https://github.com/FirebirdSQL/firebird-odbc-driver/issues</a>
+<p>Good luck!
+
+<p>&nbsp;
+<p><i>Firebird dev & support team</i>
+
+
+
+
+
+</body>
diff --git a/README.md b/README.md
@@ -3,11 +3,12 @@
 Firebird ODBC driver v3.0
 
 Welcome to the latest release of the Firebird ODBC driver v3.0. This release
-sees many significant advances in the driver. The most notable is that this version has OOAPI implementation inside.
+sees many significant advances in the driver.
+The most notable is that this version has OOAPI implementation inside.
 
 This version is for Firebird 3.0 and later clients only.
 
-All the new features and fixes are documented in the release notes.
+All the new features and fixes are documented in the release notes - ./Install/ReleaseNotes_v3.0.html
 
 ## Development