Skip to content

Commit 9cc4d02

Browse files
committed
Docs: Adapt to version bump and library rename
1 parent b0bfd6b commit 9cc4d02

File tree

4 files changed

+18
-36
lines changed

4 files changed

+18
-36
lines changed

doc/devapi_ref.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ the [list of X DevAPI classes](@ref devapi).
4242
The following Connector/C++ application connects to a MySQL Server over
4343
X protocol, creates a document collection, adds a few documents to it, queries
4444
the collection and displays the result. The sample code can be found in file
45-
`testapp/devapi_test.cc` in the source distribution of Connector/C++ 8.
45+
`testapp/devapi_test.cc` in the source distribution of Connector/C++.
4646
See @ref usage for instructions on how to build the sample code.
4747

4848
@dontinclude devapi_test.cc

doc/jdbc_ref.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Connector/C++ 8 classic JDBC API Example {#jdbc_example}
1+
Connector/C++ classic JDBC API Example {#jdbc_example}
22
=======================================
33

44
Connector/C++ supports the classic C++ API based on the JDBC4 specification.
5-
This allows an easy migration to Connector/C++ 8 for applications that use
5+
This allows an easy migration to Connector/C++ for applications that use
66
earlier versions of Connector/C++ (e.g., version 1.1). See also
77
[MySQL Connector/C++ 1.1 Developer Guide](https://dev.mysql.com/doc/connector-cpp/1.1/en/).
88

doc/usage.txt

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Using Connector/C++ 8 {#usage}
2-
===============================
1+
Using Connector/C++ {#usage}
2+
============================
33

44
It is easiest to use Connector/C++ from a CMake project. For any target that
55
uses Connector/C++ it is enough to link that target with the `mysql::concpp`
@@ -36,7 +36,7 @@ variable to the top-level Connector/C++ install location:
3636

3737
@note
3838
The `mysql-concpp` cmake module is defined starting from version 8.3.0. For
39-
earlier versions of Connector/C++ 8 one has to configure build manually setting
39+
earlier versions of Connector/C++ one has to configure build manually setting
4040
correct include paths, link libraries etc. See @ref manual_config
4141

4242
Connector/C++ implements three APIs for communicating with MySQL Server. Two
@@ -67,28 +67,18 @@ For earlier versions the following set of headers needs to be included instead:
6767
where the exact set of headers represented by `<mysql/cppconn/*.h>` pattern
6868
depends on the APIs used in the code.
6969

70-
@note Legacy code writen against erlier versions of Connector/C++ might have
71-
includes of the following form (without `mysql/` prefix):
72-
~~~~
73-
#include <mysql_driver.h>
74-
#include <mysql_connection.h>
75-
#include <cppconn/*.h>
76-
~~~~
77-
To build such code with Connector/C++ 8 without modifying it, add
78-
`${mysql-concpp_DIR}/include/jdbc` to the include path.
79-
8070

8171
### Linking with Connector/C++ dynamically
8272

8373
Connector targets defined by `mysql-concpp` module refer to shared connector
8474
libraries and imply dynamic linking. Depending on the platform, the shared
8575
Connector/C++ library is named:
8676

87-
- `libmysqlcppconn8.so` on Unix platforms (soname `libmysqlcppconn8.so.B`)
88-
- `libmysqlcppconn8.dylib` on the OSX platform (link name
89-
`libmysqlcppconn8.B.dylib`)
90-
- `mysqlcppconn8-B-vs14.dll` on Windows platforms
91-
(with import library vs14/mysqlcppconn8.lib).
77+
- `libmysqlcppconnx.so` on Unix platforms (soname `libmysqlcppconnx.so.B`)
78+
- `libmysqlcppconnx.dylib` on the OSX platform (link name
79+
`libmysqlcppconnx.B.dylib`)
80+
- `mysqlcppconnx-B-vs14.dll` on Windows platforms
81+
(with import library vs14/mysqlcppconnx.lib).
9282

9383
The classic API implementation is placed in a separate library which
9484
has `libmysqlcppconn` as the base name: `libmysqlcppconn.so`,
@@ -100,7 +90,7 @@ used when building the application and when running it must match.
10090
The `-vs14` suffix used in Windows names indicates supported Microsoft Visual
10191
Studio toolchain version and is there to allow installing and using on the same
10292
computer connector libraries targeted at different VS versions. Currently
103-
Connector/C++ supports VS2019 and VS2020 and they both use the same major
93+
Connector/C++ supports VS2019 and VS2022 and they both use the same major
10494
toolchain version 14. Therefore only `-vs14` variants of libraries are shipped
10595
at the moment.
10696

@@ -177,14 +167,6 @@ will set variable `MYSQL_CONCPP_DEBUG_FOUND` to true if debug libraries were
177167
found.
178168

179169

180-
@note
181-
The `mysql-concpp` module always expects the release variant of the connector
182-
to be present at the install location. If using custom installation that
183-
contains only debug builds the `find_module(mysql-concpp)` command will fail
184-
with error. At this point such debug-only installation can be used only after
185-
manual setting of appropriate compiler and linker flags.
186-
187-
188170
### Connector dependencies
189171

190172
Connector/C++ libraries depend on OpenSSL. For system-wide installations this
@@ -308,15 +290,15 @@ following:
308290
- The `${mysql-concpp_DIR}/include` directory is added to the compiler
309291
include path.
310292

311-
- The connector shared library `libmysqlcppconn8.so`
312-
(`libmysqlcppconn8.dylib` in case of MacOS) is added to linker inputs. For
293+
- The connector shared library `libmysqlcppconnx.so`
294+
(`libmysqlcppconnx.dylib` in case of MacOS) is added to linker inputs. For
313295
the library implementing the classic API the names are `libmysqlcppconn.so`
314296
and `libmysqlcppconn.dylib`. It is best to specify full paths to these
315297
libraries which are found at `${mysql-concpp_DIR}/lib64`.
316298

317299
- On Windows the linker line should refer to the import library (rather than
318300
the DLL) that is located at `${mysql-concpp_DIR}/lib64/vs14`. The import
319-
library name is `mysqlcppconn8.lib` (`libmysqlcppconn.lib` for the classic
301+
library name is `mysqlcppconnx.lib` (`libmysqlcppconn.lib` for the classic
320302
library).
321303

322304
We do not try to cover manual build configuration for static linking here. It
@@ -327,7 +309,7 @@ it does in your particular scenario.
327309

328310

329311
<!--
330-
Copyright (c) 2015, 2020, Oracle and/or its affiliates.
312+
Copyright (c) 2015, 2024, Oracle and/or its affiliates.
331313

332314
This program is free software; you can redistribute it and/or modify
333315
it under the terms of the GNU General Public License, version 2.0, as

doc/xapi_ref.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Connector/C++ 8 X DevAPI for C Example {#xapi_example}
2-
======================================================
1+
Connector/C++ X DevAPI for C Example {#xapi_example}
2+
====================================================
33

44
Connector/C++ implements a variant of X DevAPI that can be used by applications
55
written in plain C - the X DevAPI for C. It allows one to work with

0 commit comments

Comments
 (0)