Commit c4be740b authored by Kai Koehne's avatar Kai Koehne
Browse files

README: Update section about private headers



It's not only QmlDesigner that nowadays uses private API.

Change-Id: I87ea88e780b3a8d7169d4c75e84dc4e78dd7cab7
Reviewed-by: default avatarLeena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: default avatarThomas Hartmann <Thomas.Hartmann@digia.com>
parent 53fb29bd
...@@ -37,27 +37,28 @@ Installation ("make install") is not needed. It is however possible, using ...@@ -37,27 +37,28 @@ Installation ("make install") is not needed. It is however possible, using
make install INSTALL_ROOT=$INSTALL_DIRECTORY make install INSTALL_ROOT=$INSTALL_DIRECTORY
Compiling Qt Quick Designer Private Header Dependencies
--------------------------- ---------------------------
Qt Quick Designer (QmlDesigner plugin) depends on "private" headers from Qt The Qt Quick Designer and the QNX plugin, and on Windows the Utils library,use
4.8.0, specifically from the QtDeclarative module. These private headers always private headers of Qt. These private headers always end with an "_p.h". Digia
end with an "_p.h". Digia does not promise to keep these files or APIs binary and the Qt Project do not promise to keep these files or APIs binary or source
or source compatible between releases. This means that when compiled, the compatible between releases. This means that when compiled, Qt Creator has a
plugin has a dependency to the exact Qt version it was compiled with. Running dependency to the exact Qt version it was compiled with. Running Qt Creator
Qt Creator with the plugin against updated Qt libraries (also for patch against updated Qt libraries (also for patch releases) might lead to link time
releases) might lead to link time failures, or even crashes. failures, or even crashes.
If you want to disable the plugin, you can pass "QT_PRIVATE_HEADERS=" to qmake: If you want to disable the plugins on Linux and Mac OS X, you can pass
"QT_PRIVATE_HEADERS=" to qmake:
qmake "QT_PRIVATE_HEADERS=" $SOURCE_DIRECTORY/qtcreator.pro qmake "QT_PRIVATE_HEADERS=" $SOURCE_DIRECTORY/qtcreator.pro
The plugin is not compiled if the private header files are not found. This The plugins are also automatically omitted if the private header files are
might be the case when you use a Qt version from your distribution, or not found. This might be the case when you use a Qt version from your
installed a self-compiled Qt to a separate directory via 'make install'. You distribution, or installed a self-compiled Qt to a separate directory via
can fix this by either re-building your Qt with the "-developer-build" 'make install'. You can fix this by either re-building your Qt with the
configure option, or by passing the include directory in the source directory "-developer-build" configure option, or by passing the include directory in
to qmake. For example: the source directory to qmake. For example:
qmake "QT_PRIVATE_HEADERS=$$QT_BUILD_TREE/include" $SOURCE_DIRECTORY/qtcreator.pro qmake "QT_PRIVATE_HEADERS=$$QT_BUILD_TREE/include" $SOURCE_DIRECTORY/qtcreator.pro
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment