diff options
author | Craig Scott <craig.scott@qt.io> | 2021-09-20 15:01:48 +1000 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-09-21 06:30:06 +0000 |
commit | 5c78a4e2061f44ac92cfd5e68898a83be1cd216e (patch) | |
tree | ef5d0415fd6fb1e4696b5e1f538223ca25120066 | |
parent | 5078d31d77c1baac2b9f1c75160ffa8e107efaff (diff) |
Add docs for qt_allow_non_utf8_sources()
Task-number: QTBUG-95712
Change-Id: Ie09785ced5b2bf8098ccff3467f32244f32f9195
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
(cherry picked from commit 30e2f51dab3dbf86f81b299eea515872e10286ef)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/corelib/Qt6CoreMacros.cmake | 3 | ||||
-rw-r--r-- | src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc | 54 | ||||
-rw-r--r-- | src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc | 1 |
3 files changed, 55 insertions, 3 deletions
diff --git a/src/corelib/Qt6CoreMacros.cmake b/src/corelib/Qt6CoreMacros.cmake index f5ee8acf3f..67b5dd5673 100644 --- a/src/corelib/Qt6CoreMacros.cmake +++ b/src/corelib/Qt6CoreMacros.cmake @@ -2121,9 +2121,6 @@ if(NOT QT_NO_CREATE_VERSIONLESS_FUNCTIONS) endfunction() endif() -# By default Qt6 forces usage of utf8 sources for consumers of Qt. -# Users can opt out of utf8 sources by calling this function with the target name of their -# application or library. function(qt6_allow_non_utf8_sources target) set_target_properties("${target}" PROPERTIES QT_NO_UTF8_SOURCE TRUE) endfunction() diff --git a/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc new file mode 100644 index 0000000000..02aa9f316e --- /dev/null +++ b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc @@ -0,0 +1,54 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qt_allow_non_utf8_sources.html +\ingroup cmake-macros-qtcore + +\title qt_allow_non_utf8_sources +\target qt6_allow_non_utf8_sources + +\brief Prevent forcing source files to be treated as UTF-8 for Windows. + +\section1 Synopsis + +\badcode +qt_allow_non_utf8_sources(target) +\endcode + +\versionlessCMakeCommandsNote qt6_allow_non_utf8_sources() + +\section1 Description + +When building with some compilers for Windows, targets that link to a Qt library +will use flags that force the compiler to treat its source files as UTF-8. This +is currently implemented for Visual Studio and Intel compilers. You can disable +this behavior on a per-target basis by calling \c{qt_allow_non_utf8_sources()} +and passing the target as the argument. + +\sa {qt6_disable_unicode_defines}{qt_disable_unicode_defines()} +*/ diff --git a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc index 9f79af2f85..b70a7b9f92 100644 --- a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc +++ b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc @@ -50,4 +50,5 @@ qmake behavior, but it is a change compared to the CMake API behavior in Qt 5. Calling \c{qt_disable_unicode_defines()} on a \c target prevents these compiler definitions from being automatically set. +\sa {qt6_allow_non_utf8_sources}{qt_allow_non_utf8_sources()} */ |