Skip to content

Commit

Permalink
docs bugfix qmake static vs staticlib
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
silverqx committed Apr 23, 2024
1 parent c67db62 commit 1d0c708
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/building/tinyorm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ Everything is ready for build, you can press <kbd>Ctrl</kbd>+<kbd>b</kbd> to bui
| `build_loadable_drivers` | `OFF` | Build `TinyDrivers` as a shared library and SQL database drivers (eg. `TinyMySql`) as shared libraries ([`Loadable`](tinydrivers/getting-started.mdx#the-loadable-sql-drivers-build) modules) that are loaded at runtime using `LoadLibrary()` on Windows or `dlopen()` on Linux. |
| `build_mysql_driver` | `OFF` | Build `TinyDrivers` MySQL database driver.<br/><small>It's enabled by default when `build_shared_drivers`, `build_loadable_drivers`, or `build_static_drivers` is enabled.<br/>Available when: `build_shared_drivers` OR `build_loadable_drivers` OR `build_static_drivers`</small> |
| `build_shared_drivers` | `OFF` | Build `TinyDrivers` as a [`Shared`](tinydrivers/getting-started.mdx#the-shared-library-build) library. |
| `build_static_drivers` | `OFF` | Build `TinyDrivers` as a [`Static`](tinydrivers/getting-started.mdx#the-static-build) library archive.<br/><small>The `build_static_drivers` `qmake` configuration option will be select by default when the `CONFIG*=staticlib` is enabled.</small> |
| `build_static_drivers` | `OFF` | Build `TinyDrivers` as a [`Static`](tinydrivers/getting-started.mdx#the-static-build) library archive.<br/><small>The `build_static_drivers` `qmake` configuration option will be select by default when the [`CONFIG*=static`](#static) is enabled.</small> |
| `build_tests` | `OFF` | Build TinyORM unit tests. |
| `disable_autoconf` | `OFF` | Disable the [`Auto-configuration`](#auto-configuration-internals) feature <small>(auto-configuration is enabled by default from `TinyORM` `v0.34.0`)</small>. |
| `disable_dotenv` | `OFF` | Disable the [`tiny_dotenv`](#environment-files) feature <small>(environment files are enabled by default from `TinyORM` `v0.34.0`)</small>. |
Expand Down Expand Up @@ -797,7 +797,7 @@ Important `qmake` options.
| ----------------------------------- | ------- | ----------- |
| `ccache` | `OFF` | Enable compiler cache. [Homepage](https://ccache.dev/)<br/><small>It works only on the Unix systems. It works well with the `g++` and `clang++` and also supports precompiled headers.</small> |
| `precompile_header` | `-` | Enable precompiled headers, you can disable them with:<br/> `CONFIG-=precompile_header`.<br/><small>The `precompile_header` is enabled by default on `msvc`, `g++`, `clang++`, `clang-cl` on `Windows` and disabled by default on `linux`.</small> |
| `static`<br/>`staticlib` | `OFF` | Build as a `static` library (lib only).<br/><small>If you want to build all libraries in the `TinyORM` project as static library archives and link against static libraries use the `CONFIG += static`. Don't use the `CONFIG += staticlib`.<br/>See [NOTES.txt](https://github.com/silverqx/TinyORM/blob/main/NOTES.txt) for more information (search `static vs staticlib`).</small> |
| `static`<br/>`staticlib` | `OFF` | Build as a `static` library (lib only).<br/><small>If you want to build all libraries in the `TinyORM` project as static library archives and link against static libraries use the [`CONFIG += static`](https://doc.qt.io/qt/qmake-variable-reference.html#config). Don't use the `CONFIG += staticlib`.<br/>See [NOTES.txt](https://github.com/silverqx/TinyORM/blob/main/NOTES.txt) for more information (search `static vs staticlib`).</small> |
| `static_runtime` | `OFF` | Link against the `shared` (dynamic) or `static` run-time library.<br/><small>The `-MD` becomes `-MT` and `-MDd` becomes `-MTd`. It works only on `MSVC` and `MinGW` or `MSYS2`.<br/>Please <u>don't use</u> this option.<br/>Available when: `msvc` or `mingw`</small> |

</APITable>
Expand Down
2 changes: 1 addition & 1 deletion docs/tinydrivers/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ To control shared and static build use [`BUILD_SHARED_LIBS`](https://cmake.org/c

See [qmake build options](building/tinyorm.mdx#qmake-build-options), related `qmake` configuration options are:<br/>[`build_loadable_drivers`](building/tinyorm.mdx#build_loadable_drivers), [`build_mysql_driver`](building/tinyorm.mdx#build_mysql_driver), [`build_shared_drivers`](building/tinyorm.mdx#build_shared_drivers), and [`build_static_drivers`](building/tinyorm.mdx#build_static_drivers)

To control shared and static build use [`staticlib`](https://doc.qt.io/qt/qmake-variable-reference.html#config) `qmake` configuration option.
To control shared and static build use [`static`](building/tinyorm.mdx#static) `qmake` [configuration option](https://doc.qt.io/qt/qmake-variable-reference.html#config).

### Performance

Expand Down

0 comments on commit 1d0c708

Please sign in to comment.