Skip to content
Snippets Groups Projects
Select Git revision
  • master default
1 result
Blame Permalink
api_review_qt_6_7_part3.md 9.78 KiB

Task and links

https://bugreports.qt.io/browse/QTBUG-121136 https://git.qt.io/alcroito/qt6-cmake-api-review/-/blob/master/api_review_qt_6_7_part3.md

Changes

qttools

qt_add_lrelease - New API options and changed option

Make the target argument of qt_add_lrelease optional. Passing a target as the first argument to qt_add_lrelease was deprecated.

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-lrelease.html

https://codereview.qt-project.org/c/qt/qttools/+/496435

Old signature

qt_add_lrelease(target TS_FILES file1.ts [file2.ts ...]
                [NO_TARGET_DEPENDENCY]

New signature

qt_add_lrelease(TS_FILES file1.ts [file2.ts ...]
                [LRELEASE_TARGET target-name]
                [EXCLUDE_FROM_ALL]

Documented. No specific example snippet. No "since qt version" blurb for new / changed options. NO_TARGET_DEPENDENCY disappeared from docs, not mentioned in deprecated section. First target option that is now deprecated IS documented.

Notes:

Action points: AP: Add synopsis for old qt <6.7 version as well, this means restoring the NO_TARGET_DEPENDENCY option and documentation AP: Add since qt version for relevant options AP: Old snippet uses the deprecated API, update to use new API AP: Add LRELEASE_TARGET option to example snippet AP: Check what happens if NO_TARGET_DEPENDENCY is used with the new API

qt_add_lupdate - New API options and changed option

Allow specifying multiple targets in qt_add_lupdate

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-lupdate.html

https://codereview.qt-project.org/c/qt/qttools/+/495546

Old signature

qt_add_lupdate(target TS_FILES file1.ts [file2.ts ...]

New signature

qt_add_lupdate(TS_FILES file1.ts [file2.ts ...]
               [TARGETS target1 [target2 ...]]

Documented. No specific example snippet. No "since qt version" blurb for new / changed options. First target option that is now deprecated IS documented.

Notes:

Action points: AP: Add synopsis for old qt <6.7 version as well and documentation for old synopsis AP: Add since qt version for relevant options AP: Old snippet uses the deprecated API, update to use new API AP: Make sure to mention LUPDATE_TARGET in example snippet AP: Rename TARGETS to SOURCE_TARGETS

qt_collect_i18n_targets - New API

Add qt_collect_i18n_targets, collects targets that are eligible for translation.

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-collect-targets-for-translation.html

https://codereview.qt-project.org/c/qt/qttools/+/496434

Signature

qt_collect_i18n_targets(out_var [DIRECTORY path])

Documented. Has "since qt version" blurb. Has example snippet.

Notes:

Action points: AP: Rename to qt_collect_translation_source_targets, make sure doc snippet is updated to use qt_add_lupdate(SOURCE_TARGETS) AP: Adjust example snippet wording that the 'tests' won't be collected for translation AP: Link to upstream cmake doc for BUILDSYSTEM_TARGETS AP: Provide example snippet how to use with cmake_language(DEFER CALL)

QT_EXCLUDE_FROM_TRANSLATION - New target and directory properties

Targets can be excluded from translation by setting the target property QT_EXCLUDE_FROM_TRANSLATION to TRUE

Targets below a certain directory can be excluded from translation by setting the directory property QT_EXCLUDE_FROM_TRANSLATION to TRUE.

https://doc-snapshots.qt.io/qt6-dev/cmake-directory-property-qt-exclude-from-translation.html https://doc-snapshots.qt.io/qt6-dev/cmake-target-property-qt-exclude-from-translation.html

https://codereview.qt-project.org/c/qt/qttools/+/496434

Documented. Has "since qt version" blurb. No example snippets.

Notes:

Action points: AP: Add doc snippets to the properties on how to set them

QT_EXCLUDE_SOURCES_FROM_TRANSLATION - New target property

Allow excluding target sources from i18n. The target property QT_EXCLUDE_SOURCES_FROM_TRANSLATION was added to exclude source files of a target from handling with lupdate.

https://doc-snapshots.qt.io/qt6-dev/cmake-target-property-qt-exclude-sources-from-translation.html

https://codereview.qt-project.org/c/qt/qttools/+/498913

Signature

set_property(TARGET myapp PROPERTY QT_EXCLUDE_SOURCES_FROM_TRANSLATION
    untranslatable.cpp
    3rdparty/*
)

Documented. Has "since qt version" blurb. Has example snippet.

Notes:

Action points: AP: Link to both qt_add_lupdate and qt_collect_i18n_targets AP: Add doc whether one wildcard matches subdirectories as well AP: Clarify what are excluded from translation. means, it refers to SOURCE_TARGETS option of qt_add_lupdate

qt_add_translations - New API options and behavior change

Support project-wide i18n with qt_add_translations. Gained the TARGETS argument to specify multiple targets that intend to load .qm files.

Gained the SOURCE_TARGETS argument to specify multiple targets that contain sources with translatable strings.

If the first argument of qt_add_translations is a target, that target is not used anymore for extracting translatable sources.

Now defers itself to the end of the scope of PROJECT_SOURCE_DIR if SOURCE_TARGETS is not given. This behavior can be turned off by passing IMMEDIATE_CALL.

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-translations.html

https://codereview.qt-project.org/c/qt/qttools/+/498033

Old signature

qt_add_translations(target TS_FILES file1.ts [file2.ts ...]

New signature

qt_add_translations([target]
                    [TARGETS target1 [target2...]]
                    [SOURCE_TARGETS target1 [target2...]]
                    TS_FILES file1.ts [file2.ts ...]
                    [IMMEDIATE_CALL])

Documented. No IMMEDIATE_CALL example snippet. Partial "since qt version" blurb for new / changed options.

Notes:

Action points: AP: There is a use case to pass in extra qm files (e.g qt sdk translations) to qt_add_translations to merge them, currently not released, open gerrit change, possibly in Qt 6.8. AP: Look into what happens when id-based translations are mixed with regular translations https://doc.qt.io/qt-6/linguist-id-based-i18n.html AP: Mention idbased option on qt_add_translations doc page, and link to page above just mention LRELEASE_OPTIONS -idbased AP: Kai: Talk to qt design team why they use idbased translations

Extra APs: AP: Add example snippet that uses SOURCE_TARGETS AP: Add synopsis for old signature as well AP: Consider removing doc section 'qt_add_translations before Qt 6.7' because we will document old synopsis

qt_add_translations - New API options and behavior change

Automatically determine .ts file names in qt_add_translations

The TS_FILES argument of qt_add_translations is optional now, and .ts file paths can be automatically determined after setting the QT_I18N_LANGUAGES variable.

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-translations.html

https://codereview.qt-project.org/c/qt/qttools/+/501634

Old signature

qt_add_translations([target]
                    TS_FILES file1.ts [file2.ts ...]

New signature

qt_add_translations([target]
                    [TS_FILE_BASE name]
                    [TS_FILE_DIR directory]
                    [TS_FILES file1.ts [file2.ts ...]]

Documented. Has example snippet. No "since qt version" blurb for new options.

Notes:

Action points: AP: Document that variable QT_I18N_LANGUAGES, newly renamed to something that i don't remember, is set when qt_standard_project_setup(I18N_LANGUAGES de fr) is called in Automatic Determination of .ts File Paths section. AP: Add doc snippet with TS_FILE_BASE and example output.

qt_add_translations - Behavior change

Automatically determine the path of the native .ts file

If the TS_FILES argument is not passed to qt_add_translations, the path to the native .ts file is automatically determined if QT_I18N_NATIVE_LANGUAGE variable is set.

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-translations.html

https://codereview.qt-project.org/c/qt/qttools/+/503733

Documented. No example / comparison snippet. No "since qt version" blurb for new options.

Notes:

Action points: AP: All good

qt_add_lupdate - New API options and behavior change

Add a way to specify the native language for i18n

https://doc-snapshots.qt.io/qt6-dev/qtlinguist-cmake-qt-add-translations.html

https://codereview.qt-project.org/c/qt/qttools/+/502121

Old signature

qt_add_lupdate(TS_FILES file1.ts [file2.ts ...]

New signature

qt_add_lupdate(TS_FILES file1.ts [file2.ts ...]
               [NATIVE_TS_FILE file.ts]

Documented. No example snippet. No "since qt version" blurb for new options.

Notes:

Action points: AP: Add synopsis for old signature. AP: NATIVE_TS_FILE already renamed to plurals, double check that no more native is mentioend. AP: Make QT_I18N_NATIVE_LANGUAGE link to actual doc page in Native Language doc section.

Overall translations documentation page

We are missing a more general adding translations page after all the new API was added.

The most prominent CMake one is

https://doc-snapshots.qt.io/qt6-dev/cmake-get-started.html#adding-translations

which is quite short.

And the generic ones at

https://doc-snapshots.qt.io/qt6-dev/internationalization.html https://doc-snapshots.qt.io/qt6-dev/localization.html

don't mention very much about build systems.

Notes:

Action points: AP: In adding translations section on getting started with cmake, remove TS_FILES, because already implicit. Add sentence and link to bigger example on doc page of qt_add_translations. See if anything else makes sense to change. AP: File task to revise the above two generic links if makes sense to modify anything.