Skip to content

Commit 85b0ecb

Browse files
committed
docs: final touches before 2.0.3 release.
1 parent 195d4fb commit 85b0ecb

File tree

2 files changed

+26
-27
lines changed

2 files changed

+26
-27
lines changed

doc/building.txt

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $ cmake --build . --config CCC
5151
~~~~~~~
5252

5353
where `CCC` is the build configuration to use, such as `Release` or `Debug`.
54-
It is also possible to omit `--config CCC` option in which case the default
54+
It is also possible to omit the `--config CCC` option in which case the default
5555
`Debug` configuration will be used.
5656

5757
@note
@@ -62,19 +62,19 @@ It is also possible to omit `--config CCC` option in which case the default
6262
After a successful build, the build location should contain
6363
the Connector/C++ shared library:
6464

65-
- `libmysqlcppconn2.so.1.0` on Unix,
66-
- `libmysqlcppconn2.1.0.dylib` on OS X,
65+
- `libmysqlcppconn2.so.1.0` on Unix
66+
- `libmysqlcppconn2.1.0.dylib` on OS X
6767
- `CCC/mysqlcppconn2-vsXX.dll` on Windows, where `-vs12` or `-vs14` prefix
68-
depends on the MSVC version used to build the connector.
68+
depends on the MSVC version used to build the connector
6969

7070
On Unix and OS X also appropriate symbolic links are created. On Windows the
7171
import library for the DLL is created at `CCC/mysqlcppconn2.lib` (the `CCC/`
7272
subdirectory is named the same as the build configuration used).
7373

7474
In the case of a static library build, the output library names are:
7575

76-
- `libmysqlcppconn2-static.a` on Unix and OS X,
77-
- `CCC/mysqlcppconn2-static.lib` on Windows.
76+
- `libmysqlcppconn2-static.a` on Unix and OS X
77+
- `CCC/mysqlcppconn2-static.lib` on Windows
7878

7979

8080
### Testing
@@ -95,7 +95,7 @@ $ cmake --build . --target install --config CCC
9595
@note
9696
It is possible to change the `CMAKE_INSTALL_PREFIX` setting before doing
9797
the installation. To change it, issue the following command before building
98-
`install` target:
98+
the `install` target:
9999
~~~~~~~
100100
$ cmake -DCMAKE_INSTALL_PREFIX=<new location> .
101101
~~~~~~~
@@ -113,8 +113,8 @@ subdirectory of the build location.
113113

114114
@note
115115
On Windows, if the connector was built with the static runtime by specifying
116-
`-DSTATC_MSVCRT=yes` configuration option (see below), the same option must
117-
be added to the build configuration of test programs.
116+
the `-DSTATC_MSVCRT=yes` configuration option (see below), the same option
117+
must be added to the build configuration of test programs.
118118

119119
@note
120120
The 32/64-bit Windows `cmake` generator (`"Visual Studio 12 2013 Win64"` vs
@@ -206,9 +206,8 @@ Connector/C++ uses C++11 language and for that reason it is not possible
206206
to build it with Microsoft Visual Studio 2010 or earlier.
207207

208208
On Windows one can request that Connector/C++ uses the static runtime library
209-
(The `/MT*` compiler option) by setting:
210-
211-
- `-DSTATIC_MSVCRT=yes`
209+
(The `/MT*` compiler option) by setting the cmake option
210+
`-DSTATIC_MSVCRT=yes`
212211

213212
This might be necessary if code which uses Connector/C++ also uses the static
214213
runtime.
@@ -218,12 +217,12 @@ Selecting a cmake generator such as `"Visual Studio 12 2013 Win64"` vs
218217
the connector is built. An application which uses Connector/C++ must
219218
be built for the same platform as the connector.
220219

221-
Note that application which is built using 'Debug', 'Release' or other MSVC
222-
build configuration needs to link against Connector/C++ library built
223-
with the same configuration (as determined by the cmake option `--config=CCC`
224-
described above). Linker leaves library built using configuration `CCC` in
225-
a `CCC/` subfolder of the build location. Thus, when building an application
226-
that uses the connector library, one has to point linker at the location
220+
An application built using 'Debug', 'Release' or other MSVC build configuration
221+
needs to link against a Connector/C++ library built with the same configuration
222+
(as determined by the `--config=CCC` cmake option described above). The linker
223+
places the library built using the `CCC` configuration in a `CCC/`
224+
subdirectory of the build location. Thus, when building an application
225+
that uses the connector library, one has to point the linker at the location
227226
containing a compatible build of the connector.
228227

229228
OS X Notes
@@ -238,8 +237,8 @@ To define the deployment target, set the environment variable
238237
of Connector/C++ are built with `MACOSX_DEPLOYMENT_TARGET` set to `10.9`.
239238

240239
Building Connector/C++ with `gcc` or its `libstdc++` runtime has not been
241-
tested and there is no support in the build system for using an alternative C++
242-
runtime library.
240+
tested and there is no support in the build system for using an alternative
241+
C++ runtime library.
243242

244243

245244
<!--

doc/usage.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ If used as a shared library, the library must be installed on the target
66
machine in order for the application to run. The shared library name is:
77

88
- `libmysqlcppconn2.so` on Unix platforms (the soname is
9-
`libmysqlcppconn2.so.1`),
9+
`libmysqlcppconn2.so.1`)
1010
- `libmysqlcppconn2.dylib` on the OSX platform (the soname is
11-
`libmysqlcppconn2.1.dylib`).
11+
`libmysqlcppconn2.1.dylib`)
1212
- `mysqlcppconn2-vsXX.dll` on Windows platforms (see
13-
[Windows Notes](@ref usage_win) for explanation of `-vsXX` suffixes),
13+
[Windows Notes](@ref usage_win) for explanation of `-vsXX` suffixes)
1414

1515
The static library name is:
1616

@@ -217,14 +217,14 @@ There are separate 32-bit and 64-bit packages, each keeping libraries in
217217
`lib/` and `lib64/` folder, respectively. The library folder contains two
218218
versions of the shared library:
219219

220-
- `mysqlcppconn2-vs12.dll` - built with MSVC 2013, compiler version 18.00,
221-
- `mysqlcppconn2-vs14.dll` - built with MSVC 2015, compiler version 19.00.
220+
- `mysqlcppconn2-vs12.dll` - built with MSVC 2013, compiler version 18.00
221+
- `mysqlcppconn2-vs14.dll` - built with MSVC 2015, compiler version 19.00
222222

223223
The corresponding import libraries are in `vs12/` or `vs14/` subfolder
224224
of the library folder:
225225

226-
- `vs12/mysqlcppconn2.lib` - import library for `mysqlcppconn2-vs12.dll`,
227-
- `vs14/mysqlcppconn2.lib` - import library for `mysqlcppconn2-vs14.dll`.
226+
- `vs12/mysqlcppconn2.lib` - import library for `mysqlcppconn2-vs12.dll`
227+
- `vs14/mysqlcppconn2.lib` - import library for `mysqlcppconn2-vs14.dll`
228228

229229
A project which uses the shared connector library must be configured to link
230230
with the import library `mysqlcppconn2.lib`. The library path should be

0 commit comments

Comments
 (0)