QtLupdateRunner | Qbs Manual
Description: A product that updates all Qt translation files in the project.

- Qbs Manual
- QbsConvenienceItems
- QtLupdateRunner
- Qbs 3.1.1

QtGuiApplication ◦ StaticLibrary

# QtLupdateRunner

A product that updates all Qt translation files in the project. More...

Since: | Qt 2.6

- List of all members, including inherited members
- QtLupdateRunner is part of List of All Items.

## Properties

- extraArguments : stringList
- limitToSubProject : bool

## Detailed Description

A QtLupdateRunner has a dependency on all products that have a Qt dependency.

Building the QtLupdateRunner product will run the lupdate tool on eligible source files from these products in order to update the project's translation files with regard to the translatable strings in these sources.

The builtByDefault property is set to `false` by default, so updating the translation files has to be explicitly requested.

The default name of the product is `"lupdate-runner"`.

To use this feature:

1. Instantiate a `QtLupdateRunner` in your project, typically at the top level:

        Project {
            // ...
            QtLupdateRunner { }
            // ...
        }

2. Trigger the translation files update by building the product:

        qbs build -p lupdate-runner

### Relevant File Tags

Tag | Since | Description
--- | --- | ---
`"qt.untranslatable"` | 2.6 | Attach this tag to source files that lupdate should not consider.

## Property Documentation

extraArguments : stringList

Additional arguments to pass to the `lupdate` tool.

Default: Undefined

limitToSubProject : bool

By default, only the source files of products that live in the same sub-project that QtLupdateRunner was instantiated in are looked at. Set this property to `false` to consider all products in the project.

Default: `true`

QtGuiApplication ◦ StaticLibrary