aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@petroules.com>2015-06-22 21:47:28 -0700
committerJake Petroules <jake.petroules@petroules.com>2015-06-24 09:49:21 +0000
commit28400aa9601e01e07010ec70e919a4b65b459321 (patch)
tree02f4c1c9980c8c9e247d7395f4a46c71bdecc581 /doc
parent5533a34d0783450b4de30797f3dd001a028ff2b1 (diff)
Add version information for module properties.
Task-number: QBS-827 Change-Id: Id45d898ea56f0320303b51293e8c30fbfb850d05 Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/modules/android-ndk-module.qdoc9
-rw-r--r--doc/reference/modules/android-sdk-module.qdoc6
-rw-r--r--doc/reference/modules/archiver-module.qdoc10
-rw-r--r--doc/reference/modules/bundle-module.qdoc35
-rw-r--r--doc/reference/modules/cpp-module.qdoc75
-rw-r--r--doc/reference/modules/ib-module.qdoc21
-rw-r--r--doc/reference/modules/java-module.qdoc17
-rw-r--r--doc/reference/modules/nodejs-module.qdoc3
-rw-r--r--doc/reference/modules/nsis-module.qdoc17
-rw-r--r--doc/reference/modules/qbs-module.qdoc29
-rw-r--r--doc/reference/modules/typescript-module.qdoc19
-rw-r--r--doc/reference/modules/wix-module.qdoc26
12 files changed, 267 insertions, 0 deletions
diff --git a/doc/reference/modules/android-ndk-module.qdoc b/doc/reference/modules/android-ndk-module.qdoc
index 5f35da18b..54187f86a 100644
--- a/doc/reference/modules/android-ndk-module.qdoc
+++ b/doc/reference/modules/android-ndk-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module Android.ndk
+ \since 1.4
\brief Provides support for building native Android libraries.
The \c Android.ndk module contains the properties and rules to create native libraries
@@ -71,16 +72,19 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li abi
\li string
+ \li 1.4
\li undefined
\li The ABI name as it appears under "lib/" in the application package.
\row
\li appStl
\li string
+ \li 1.4
\li \c{"system"}
\li The library to use for C++. The possible values are: "system", "gabi++_static",
"gabi++_shared", "stlport_static", "stlport_shared", "gnustl_static", "gnustl_shared",
@@ -88,26 +92,31 @@
\row
\li buildProfile
\li string
+ \li 1.4
\li undefined
\li The name of the build profile, e.g. "armeabi-v7a-hard".
\row
\li enableExceptions
\li bool
+ \li 1.4
\li \c{appStl !== "system"}
\li Whether to enable exceptions in C++ code.
\row
\li enableRtti
\li bool
+ \li 1.4
\li \c{appStl !== "system"}
\li Whether to enable runtime type information in C++ code.
\row
\li ndkDir
\li path
+ \li 1.4
\li undefined
\li The NDK base directory.
\row
\li platform
\li string
+ \li 1.4
\li \c{"android-9"}
\li The versioned platform name.
\endtable
diff --git a/doc/reference/modules/android-sdk-module.qdoc b/doc/reference/modules/android-sdk-module.qdoc
index ba18461ae..5fd217194 100644
--- a/doc/reference/modules/android-sdk-module.qdoc
+++ b/doc/reference/modules/android-sdk-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module Android.sdk
+ \since 1.4
\brief Provides support for building Android packages.
The \c Android.sdk module contains the properties and rules to create Android application
@@ -51,28 +52,33 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li buildToolsVersion
\li string
+ \li 1.4
\li undefined
\li The version of the build tools such as aapt and dx. The \c setup-android
tool sets this to the highest version available in the SDK.
\row
\li ndkDir
\li string
+ \li 1.4
\li undefined
\li The NDK base directory, if an NDK is present.
\row
\li platform
\li string
+ \li 1.4
\li undefined
\li The versioned platform name (e.g. "android-21"). The \c setup-android
tool sets this to the highest version available in the SDK.
\row
\li sdkDir
\li string
+ \li 1.4
\li undefined
\li The SDK base directory.
\endtable
diff --git a/doc/reference/modules/archiver-module.qdoc b/doc/reference/modules/archiver-module.qdoc
index 62c6a9684..ac8df7c58 100644
--- a/doc/reference/modules/archiver-module.qdoc
+++ b/doc/reference/modules/archiver-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module archiver
+ \since 1.4
\brief Provides support for building archives.
The \c archiver module contains the properties and rules for creating (compressed) archives.
@@ -48,22 +49,26 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li flags
\li stringList
+ \li 1.4
\li empty list
\li Custom options not covered by any of the other properties.
\row
\li archiveBaseName
\li string
+ \li 1.4
\li \c{product.targetName}
\li The base name of the archive file (in other words, the file name without
any extensions).
\row
\li compressionLevel
\li string
+ \li 1.4
\li \c undefined
\li How much effort to put into the compression of a 7-Zip archive.
Possible values are \c undefined, "0", "1", "3", "5", "7" and "9". Higher numbers
@@ -72,26 +77,31 @@
\row
\li compressionType
\li string
+ \li 1.4
\li \c{"gz"}
\li How to compress a tar archive. Possible options are "none", "gz", "bz2", "Z" and "xz".
\row
\li outputDirectory
\li string
+ \li 1.4
\li \c{product.destinationDirectory}
\li Where to put the archive file.
\row
\li type
\li string
+ \li 1.4
\li \c{undefined}
\li Which kind of archiver to use. The currently supported values are "tar" and "7zip".
\row
\li workingDirectory
\li string
+ \li 1.4
\li undefined
\li The directory in which to execute \c command.
\row
\li command
\li string
+ \li 1.4
\li Depends on \c{type}.
\li The command with which to invoke the archiver.
\endtable
diff --git a/doc/reference/modules/bundle-module.qdoc b/doc/reference/modules/bundle-module.qdoc
index 83af1582e..deeb3ed83 100644
--- a/doc/reference/modules/bundle-module.qdoc
+++ b/doc/reference/modules/bundle-module.qdoc
@@ -35,6 +35,7 @@
\ingroup list-of-modules
\title Module bundle
+ \since 1.4
\brief Provides Core Foundation bundle support.
The \c bundle module contains properties and rules for building and working with
@@ -55,11 +56,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li isBundle
\li \c{bool}
+ \li 1.4
\li \c{true} for applications and dynamic libraries on Apple platforms, \c{false} otherwise
\li Whether the product should actually be packaged as a bundle as opposed to a flat file.
This allows a product indirectly dependent on the \c{bundle} module to retain control of
@@ -67,6 +70,7 @@
\row
\li isShallow
\li \c{bool}
+ \li 1.4
\li \c{true} for iOS applications
\li Whether the bundle directory tree is "shallow", i.e. whether it lacks a Contents
subdirectory. This is the default for iOS applications and should normally never be
@@ -74,6 +78,7 @@
\row
\li identifierPrefix
\li \c{string}
+ \li 1.4
\li \c{org.example}
\li Prefix for the product's bundle identifier. If \c{identifier} is left unset, the bundle
identifier will be a concatenation of this value and the \c{identifier} property,
@@ -81,6 +86,7 @@
\row
\li identifier
\li \c{string}
+ \li 1.4
\li combination of \c{identifierPrefix} and the product's target name formatted as an
RFC 1034 identifier
\li The bundle's identifier. If left unset, the bundle identifier will be a concatenation
@@ -88,6 +94,7 @@
\row
\li extension
\li \c{string}
+ \li 1.4
\li \c{"app"} for \c{"APPL"} packages,
\c{"framework"} for \c{"FMWK"} packages,
\c{"bundle"} for \c{"BNDL"} and custom packages
@@ -96,6 +103,7 @@
\row
\li packageType
\li \c{string}
+ \li 1.4
\li \c{"APPL"} for applications,
\c{"FMWK"} for frameworks,
\c{"BNDL"} for custom bundles
@@ -106,6 +114,7 @@
\row
\li signature
\li \c{string}
+ \li 1.4
\li \c{"????"}
\li The four-letter signature specific to the bundle, also known as the creator code,
specified in the bundle's PkgInfo file and in the bundle's Info.plist as the value for
@@ -113,33 +122,39 @@
\row
\li bundleName
\li \c{string}
+ \li 1.4
\li combination of the product's \c{targetName} and bundle's \c{extension}
\li The file name of the bundle's wrapper directory.
This property should not normally need to be changed.
\row
\li frameworkVersion
\li \c{string}
+ \li 1.4
\li \c{"A"}
\li For framework bundles, the version of the framework. Unused for other package types.
\row
\li publicHeaders
\li \c{pathList}
+ \li 1.4
\li \c{undefined}
\li List of public header files to copy to a framework bundle's Headers subdirectory.
\row
\li privateHeaders
\li \c{pathList}
+ \li 1.4
\li \c{undefined}
\li List of private header files to copy to a framework bundle's PrivateHeaders subdirectory
\row
\li resources
\li \c{pathList}
+ \li 1.4
\li \c{undefined}
\li List of resources to copy to a bundle's Resources subdirectory. Files will automatically
be copied into lproj subdirectories corresponding to the input files' paths.
\row
\li infoPlistFile
\li \c{path}
+ \li 1.4
\li \c{undefined}
\li Path to the Info.plist file used by the bundle.
The contents of this file will be aggregated with the values in \c{infoPlist}.
@@ -149,6 +164,7 @@
\row
\li infoPlist
\li \c{object}
+ \li 1.4
\li \c{undefined}
\li Dictionary of key-value pairs to add to the bundle's Info.plist.
The contents of this property will be aggregated with the values from \c{infoPlistFile}.
@@ -158,6 +174,7 @@
\row
\li processInfoPlist
\li \c{bool}
+ \li 1.4
\li \c{true}
\li Whether to perform post-processing on the aggregated Info.plist contents.
If this property is \c{true}, various post-processing operations will be applied to the
@@ -172,12 +189,14 @@
\row
\li embedInfoPlist
\li \c{bool}
+ \li 1.4
\li \c{true} if the product is a command line tool, otherwise \c{false}.
\li Whether to create a __TEXT section in the product's executable containing the processed
Info.plist. Only applies to command line applications.
\row
\li infoPlistFormat
\li \c{string}
+ \li 1.4
\li \c{"binary1"} for iOS;
\c{"same-as-input"} or \c{"xml1"} for OS X depending on whether \c{infoPlistFile} is
specified; undefined for all other operating systems.
@@ -193,55 +212,71 @@
\table
\header
\li Property
+ \li Since
\li Description
\row
\li infoPlistPath
+ \li 1.4
\li Path that the Info.plist file will be written to. If \c{embedInfoPlist} is \c{true},
this will point to a file in a temporary directory.
\row
\li infoPlistPath
+ \li 1.4
\li Path that the PkgInfo file will be written to.
\row
\li versionPlistPath
+ \li 1.4
\li Path that the version.plist file will be written to.
\row
\li executablePath
+ \li 1.4
\li Path that the main executable file will be written to.
\row
\li executableFolderPath
+ \li 1.4
\li Path of the directory where the main exectuable will be written.
Not to be confused with \c{executablesFolderPath}.
\row
\li executablesFolderPath
+ \li 1.4
\li Path of the directory where auxiliary executables will be copied.
Not to be confused with \c{executableFolderPath}.
\row
\li frameworksFolderPath
+ \li 1.4
\li Path of the directory where internal frameworks will be copied.
\row
\li pluginsFolderPath
+ \li 1.4
\li Path of the directory where plugins will be copied.
\row
\li privateHeadersFolderPath
+ \li 1.4
\li Path of the directory where private header files will be copied.
\row
\li publicHeadersFolderPath
+ \li 1.4
\li Path of the directory where public headers files will be copied.
\row
\li scriptsFolderPath
+ \li 1.4
\li Path of the directory where script files will be copied.
\row
\li sharedFrameworksFolderPath
+ \li 1.4
\li Path of the directory where shared frameworks will be copied.
\row
\li sharedSupportFolderPath
+ \li 1.4
\li Path of the directory where shared support files will be copied.
\row
\li unlocalizedResourcesFolderPath
+ \li 1.4
\li Path of the directory where non-localized resource files will be copied.
This is the same as the base resources path.
\row
\li contentsFolderPath
+ \li 1.4
\li Path of the bundle's Contents subdirectory.
\endtable
*/
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc
index 7d2ec184b..d12396c49 100644
--- a/doc/reference/modules/cpp-module.qdoc
+++ b/doc/reference/modules/cpp-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module cpp
+ \since 1.0
\brief Provides C/C++ support.
The \c cpp module contains the properties and rules for toolchains of the C/C++ family.
@@ -45,11 +46,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li allowUnresolvedSymbols
\li \c{bool}
+ \li 1.2
\li \c{false}
\li Switch this on if you want the linking step to succeed even if the resulting binary
contains unresolved symbols. Normally this makes little sense, but in special cases it
@@ -58,22 +61,26 @@
\row
\li architecture
\li \c{string}
+ \li 1.0
\li \c{qbs.architecture}
\li Target architecture. See \c{qbs.architecture}.
\row
\li debugInformation
\li \c{bool}
+ \li 1.0
\li \c{qbs.debugInformation}
\li Generate debug information. See \c{qbs.debugInformation}.
\row
\li separateDebugInformation
\li \c{bool}
+ \li 1.4
\li \c{false} for gcc/clang, \c{true} for MSVC
\li Whether to store debug information in an external file or bundle instead of within the
binary.
\row
\li defines
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of preprocessor macros that gets passed to the compiler.
To set macro values use the following syntax:
@@ -81,24 +88,28 @@
\row
\li platformDefines
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of preprocessor macros that are used for all projects that are built for the
current target platform. User project files usually do not set this property.
\row
\li compilerDefines
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of preprocessor macros that are used for all projects that are using the current
toolchain. User project files usually do not set this property.
\row
\li includePaths
\li \c{pathList}
+ \li 1.0
\li \c{undefined}
\li List of include paths. Relative paths are considered to be relative to the .qbs product
file they are used in.
\row
\li systemIncludePaths
\li \c{pathList}
+ \li 1.0
\li \c{undefined}
\li List of include paths that are passed as system include paths to the compiler.
For header files in those paths warnings will be ignored.
@@ -106,30 +117,35 @@
\row
\li libraryPaths
\li \c{pathList}
+ \li 1.0
\li \c{undefined}
\li List of library search paths. Relative paths are considered to be relative to the .qbs
product file they are used in.
\row
\li dynamicLibraries
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of dynamic libraries to be linked. If the library is part of your project, consider
using a Depends item instead.
\row
\li staticLibraries
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of static libraries to be linked. If the library is part of your project, consider
using a Depends item instead.
\row
\li prefixHeaders
\li \c{pathList}
+ \li 1.0.1
\li \c{undefined}
\li List of files to automatically include at the beginning of each source file in the
product.
\row
\li precompiledHeader
\li \c{path}
+ \li 1.0
\li \c{undefined}
\li Name of the header file to be precompiled.
@@ -143,82 +159,98 @@
\row
\li cPrecompiledHeader
\li \c{path}
+ \li 1.1
\li \c{precompiledHeader}
\li Name of the C header file to be precompiled.
\row
\li cxxPrecompiledHeader
\li \c{path}
+ \li 1.1
\li \c{precompiledHeader}
\li Name of the C++ header file to be precompiled.
\row
\li objcPrecompiledHeader
\li \c{path}
+ \li 1.1
\li \c{precompiledHeader}
\li Name of the Objective-C header file to be precompiled.
\row
\li objcxxPrecompiledHeader
\li \c{path}
+ \li 1.1
\li \c{precompiledHeader}
\li Name of the Objective-C++ header file to be precompiled.
\row
\li precompiledHeaderDir
\li \c{path}
+ \li 1.0
\li \c{product.buildDirectory}
\li The directory that will contain the precompiled header files.
Usually you won't need to set this.
\row
\li optimization
\li \c{string}
+ \li 1.0
\li \c{qbs.optimization}
\li Optimization level. See \c{qbs.optimization}.
\row
\li treatWarningsAsErrors
\li \c{bool}
+ \li 1.0
\li \c{false}
\li Warnings will be handled as errors and cause the build to fail.
\row
\li warningLevel
\li \c{string}
+ \li 1.0
\li \c{"all"}
\li Specifies the warning level for the compiler - \c{"none"} or \c{"all"}.
\row
\li commonCompilerFlags
\li \c{stringList}
+ \li 1.0.1
\li undefined
\li Flags that are added to all compilation commands independently of the language.
\row
\li compilerVersionMajor
\li \c{int}
+ \li 1.4
\li undefined
\li The major version of the compiler.
\row
\li compilerVersionMinor
\li \c{int}
+ \li 1.4
\li undefined
\li The minor version of the compiler.
\row
\li compilerVersionPatch
\li \c{int}
+ \li 1.4
\li undefined
\li The patch level component of the compiler version.
\row
\li cppFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the C preprocessor.
\row
\li cFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the C compiler.
\row
\li cxxFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the C++ compiler.
\row
\li cLanguageVersion
\li \c{string}
+ \li 1.4
\li undefined
\li The version of the C standard with which the code must comply. If this property is set,
corresponding compiler and/or linker flags will be added, depending on the toolchain.
@@ -227,6 +259,7 @@
\row
\li cxxLanguageVersion
\li \c{string}
+ \li 1.4
\li undefined
\li The version of the C++ standard with which the code must comply. If this property is
set, corresponding compiler and/or linker flags will be added, depending on the
@@ -235,6 +268,7 @@
\row
\li cxxStandardLibrary
\li \c{string}
+ \li 1.4
\li undefined
\li The C++ standard library to link to. If this property is set, corresponding compiler
and/or linker flags will be added, assuming the value is valid for the current
@@ -243,31 +277,37 @@
\row
\li objcFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the Objective-C compiler.
\row
\li objcxxFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the Objective-C++ compiler.
\row
\li linkerFlags
\li \c{stringList}
+ \li 1.0
\li undefined
\li Additional flags for the linker.
\row
\li linkerScripts
\li \c{pathList}
+ \li 1.2
\li \c{undefined}
\li List of linker script files.
\row
\li compilerName
\li \c{string}
+ \li 1.0
\li determined by qbs-setup-toolchains
\li Name of the main compiler binary. This is set in the build profile.
\row
\li compilerPath
\li \c{string}
+ \li 1.0
\li determined by qbs-setup-toolchains
\li Full path of the main compiler binary. This is set in the build profile.
If the toolchain provides different compilers for different languages, then
@@ -275,33 +315,39 @@
\row
\li compilerPathByLanguage
\li \c{string} to \c{string} map
+ \li 1.3
\li determined by qbs-setup-toolchains
\li Maps file tags to full paths of compiler binaries. This is set in the build profile.
\row
\li compilerWrapper
\li \c{stringList}
+ \li 1.1
\li \c{undefined}
\li Wrapper binary and its arguments for wrapping compiler calls.
This is useful for compiler wrappers like ccache and alike.
\row
\li linkerName
\li \c{string}
+ \li 1.1.1
\li determined by qbs-setup-toolchains
\li Name of the linker binary. This is set in the build profile.
\row
\li linkerPath
\li \c{string}
+ \li 1.1.1
\li determined by qbs-setup-toolchains
\li Full path of the linker binary. This is set in the build profile.
\row
\li entryPoint
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li Name of the entry point of an executable or dynamic library. If this property is
undefined, the toolchain's default is used.
\row
\li runtimeLibrary
\li \c{string}
+ \li 1.3.3
\li \c{"dynamic"} for MSVC, \c{undefined} for others
\li Type of the used runtime library. Accepted values are \c{"static"} and \c{"dynamic"}.
If this property is set to \c{undefined}, then the default runtime library of the
@@ -316,17 +362,20 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li frameworkPaths
\li \c{pathList}
+ \li 1.0
\li \c{undefined}
\li List of framework search paths. Relative paths are considered to be relative to the
.qbs product file they are used in.
\row
\li systemFrameworkPaths
\li \c{pathList}
+ \li 1.0
\li \c{undefined}
\li List of framework search paths. Relative paths are considered to be relative to the
.qbs product file they are used in. Header files in frameworks in those paths will not
@@ -334,18 +383,21 @@
\row
\li frameworks
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of frameworks to be linked.
If the framework is part of your project, consider using a Depends item instead.
\row
\li weakFrameworks
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of frameworks to be weakly linked.
If the framework is part of your project, consider using a Depends item instead.
\row
\li installNamePrefix
\li \c{string}
+ \li 1.0
\li \c{undefined}
\li The prefix for the internal install name (LC_ID_DYLIB) of a dynamic library on Darwin
(OS X and iOS). Typically this should be set to \c{"@rpath"} on modern platforms that
@@ -353,12 +405,14 @@
\row
\li automaticReferenceCounting
\li \c{bool}
+ \li 1.4
\li \c{undefined}
\li Whether to enable Automatic Reference Counting (ARC) for Objective-C and Objective-C++
source code. If \c{undefined}, uses the compiler default (probably \c{false}).
\row
\li requireAppExtensionSafeApi
\li \c{bool}
+ \li 1.4
\li \c{undefined}
\li Whether to enforce the use of only app-extension-safe APIs on OS X and iOS. This is
necessary for building Application Extensions in OS X Yosemite and iOS 8 and above. If
@@ -366,6 +420,7 @@
\row
\li minimumIosVersion
\li \c{string}
+ \li 1.0
\li undefined, but may be set by generated profiles
\li A version number in the format [major].[minor] indicating the earliest version of iOS
that the product should run on. Passes -miphoneos-version-min=<version> to the compiler.
@@ -373,6 +428,7 @@
\row
\li minimumOsxVersion
\li \c{string}
+ \li 1.0.1
\li undefined, but may be set by generated profiles
\li A version number in the format [major].[minor] indicating the earliest version of OS X
that the product should run on. Passes -mmacosx-version-min=<version> to the compiler.
@@ -385,21 +441,25 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li archiverName
\li \c{string}
+ \li 1.0
\li \c{"ar"}
\li Name of the archiver binary. This is set in the build profile.
\row
\li archiverPath
\li \c{string}
+ \li 1.0
\li determined by qbs-setup-toolchains
\li Full path of the archiver binary. This is set in the build profile.
\row
\li exportedSymbolsCheckMode
\li \c{string}
+ \li 1.4.1
\li "ignore-undefined"
\li Controls how \QBS determines whether an updated dynamic library causes relinking of
dependents. The default value is \c "ignore-undefined", which means that undefined
@@ -409,46 +469,55 @@
\row
\li nmName
\li \c{string}
+ \li 1.2
\li \c{"nm"}
\li Name of the nm binary. This is set in the build profile.
\row
\li nmPath
\li \c{string}
+ \li 1.2
\li determined by qbs-setup-toolchains
\li Full path of the nm binary. This is set in the build profile.
\row
\li objcopyName
\li \c{string}
+ \li 1.4
\li \c{"objcopy"}
\li Name of the objcopy binary. This is set in the build profile.
\row
\li objcopyPath
\li \c{string}
+ \li 1.4
\li determined by qbs-setup-toolchains
\li Full path of the objcopy binary. This is set in the build profile.
\row
\li stripName
\li \c{string}
+ \li 1.4
\li \c{"strip"}
\li Name of the strip binary. This is set in the build profile.
\row
\li stripPath
\li \c{string}
+ \li 1.4
\li determined by qbs-setup-toolchains
\li Full path of the strip binary. This is set in the build profile.
\row
\li dsymutilPath
\li \c{string}
+ \li 1.4
\li determined by qbs-setup-toolchains
\li Full path of the dsymutil binary. This is set in the build profile.
\row
\li dsymutilFlags
\li \c{stringList}
+ \li 1.4.1
\li undefined
\li Additional flags for the dsymutil tool.
\row
\li positionIndependentCode
\li \c{bool}
+ \li 1.0
\li \c{undefined}
\li Generate position independent code.
If this property is \c{undefined}, then position independent code is generated for
@@ -456,16 +525,19 @@
\row
\li rpaths
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li List of rpaths that are passed to the linker.
\row
\li useRPaths
\li \c{bool}
+ \li 1.3
\li \c{true}
\li Set this property to \c{false} to prevent the linker from writing rpaths to the binary.
\row
\li visibility
\li \c{string}
+ \li 1.0
\li \c{"default"}
\li Visibility level for exported symbols.
Possible values include: \c{"default"}, \c{"hidden"}, \c{"hiddenInlines"},
@@ -478,11 +550,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li windowsApiCharacterSet
\li \c{string}
+ \li 1.0.1
\li \c{"unicode"}
\li Specifies the character set used in the Win32 API. "unicode" will define the
preprocessor symbols UNICODE and _UNICODE, "mbcs" will define _MBCS, and
@@ -490,6 +564,7 @@
\row
\li minimumWindowsVersion
\li \c{string}
+ \li 1.0
\li undefined, but may be set by generated profiles
\li A version number in the format [major].[minor] indicating the earliest version of
Windows that the product should run on. Defines WINVER, _WIN32_WINNT, and
diff --git a/doc/reference/modules/ib-module.qdoc b/doc/reference/modules/ib-module.qdoc
index c26ba1b44..6d6e98cfd 100644
--- a/doc/reference/modules/ib-module.qdoc
+++ b/doc/reference/modules/ib-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module ib
+ \since 1.1
\brief Provides support for Apple Interface Builder and related tools and file types.
The \c ib module contains properties and rules for building Interface Builder documents,
@@ -47,26 +48,31 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li warnings
\li bool
+ \li 1.1
\li \c{true}
\li Whether to print warnings when compiling. Does not apply to icon sets.
\row
\li errors
\li bool
+ \li 1.1
\li \c{true}
\li Whether to print warnings when compiling. Does not apply to icon sets.
\row
\li notices
\li bool
+ \li 1.1
\li \c{true}
\li Whether to print warnings when compiling. Does not apply to icon sets.
\row
\li flags
\li stringList
+ \li 1.1
\li undefined
\li Additional flags to pass to the underlying tool (ibtool, actool, iconutil).
\endtable
@@ -77,23 +83,27 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li ibtoolName
\li string
+ \li 1.3
\li \c{"ibtool"}
\li Name of the ibtool binary used to compile NIBs and storyboards.
This should not normally need to be changed.
\row
\li ibtoolPath
\li string
+ \li 1.3
\li \c{ibtoolName}
\li Directory where the ibtool binary is located.
This should not normally need to be changed.
\row
\li flatten
\li bool
+ \li 1.1
\li \c{true}
\li Compiles XIBs and storyboards into flattened (non-wrapper) files.
Set to \c{false} to preserve editability of the resulting nib and storyboard
@@ -101,12 +111,14 @@
\row
\li module
\li string
+ \li 1.3
\li \c{undefined}
\li Sets the name of the module that the nib or storyboard is a part of.
Requires Xcode 6 or newer.
\row
\li autoActivateCustomFonts
\li bool
+ \li 1.3
\li \c{true}
\li Instructs the ibtool compiler to add custom fonts to the
application's Info.plist when compiling XIBs and storyboards,
@@ -120,23 +132,27 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li actoolName
\li string
+ \li 1.3
\li \c{"actool"}
\li Name of the actool binary used to compile asset catalogs.
This should not normally need to be changed.
\row
\li actoolPath
\li string
+ \li 1.3
\li \c{actoolName}
\li Directory where the actool binary is located.
This should not normally need to be changed.
\row
\li appIconName
\li string
+ \li 1.3
\li \c{undefined}
\li Name of the resource in the asset catalog that will be used as the application's icon.
Used to generate the partial Info.plist which will be merged into the resulting app.
@@ -144,6 +160,7 @@
\row
\li launchImageName
\li string
+ \li 1.3
\li \c{undefined}
\li Name of the resource in the asset catalog that will be used as the application's launch
image. Used to generate the partial Info.plist which will be merged into the resulting
@@ -152,6 +169,7 @@
\row
\li compressPngs
\li bool
+ \li 1.3
\li \c{true}
\li Whether to compress PNG image files when building asset catalogs.
\endtable
@@ -162,17 +180,20 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li iconutilName
\li string
+ \li 1.3
\li \c{"iconutil"}
\li Name of the iconutil binary used to compile icon sets.
This should not normally need to be changed.
\row
\li iconutilPath
\li string
+ \li 1.3
\li \c{iconutilName}
\li Directory where the iconutil binary is located.
This should not normally need to be changed.
diff --git a/doc/reference/modules/java-module.qdoc b/doc/reference/modules/java-module.qdoc
index 84ea08294..d3b0be6b8 100644
--- a/doc/reference/modules/java-module.qdoc
+++ b/doc/reference/modules/java-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module java
+ \since 1.4
\brief Provides Java support.
The \c java module contains the properties and rules for building Java projects.
@@ -44,83 +45,99 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li additionalClassPaths
\li stringList
+ \li 1.4
\li undefined
\li Locations beside this product's class output path to consider when compiling.
\row
\li additionalCompilerFlags
\li stringList
+ \li 1.4
\li undefined
\li Use this to supply compiler flags not covered by any of the properties in this module.
\row
\li additionalJarFlags
\li stringList
+ \li 1.4
\li undefined
\li Use this to supply archiver flags not covered by any of the properties in this module.
\row
\li bootClassPaths
\li stringList
+ \li 1.4
\li undefined
\li Use this if you need to specify non-standard bootstrap class files.
\row
\li compilerFilePath
\li string
+ \li 1.4
\li \c compilerName, prefixed by \c jdkPath if it is defined
\li The command to invoke when compiling Java sources.
\row
\li compilerName
\li string
+ \li 1.4
\li \c{"javac"}
\li The file name of the Java compiler.
\row
\li enableWarnings
\li bool
+ \li 1.4
\li \c true
\li Controls whether warnings are emitted when compiling Java sources.
\row
\li interpreterFilePath
\li string
+ \li 1.4
\li \c interpreterName, prefixed by \c jdkPath if it is defined
\li The command to invoke when executing Java code.
\row
\li interpreterName
\li string
+ \li 1.4
\li \c{"java"}
\li The file name of the Java interpreter.
\row
\li jarFilePath
\li string
+ \li 1.4
\li \c jarName, prefixed by \c jdkPath if it is defined
\li The command to run when creating or extracting \c jar files.
\row
\li jarName
\li string
+ \li 1.4
\li \c{"jar"}
\li The file name of the \c jar tool.
\row
\li jdkPath
\li path
+ \li 1.4
\li undefined
\li The base path of Java-related tools.
\row
\li languageVersion
\li string
+ \li 1.4
\li undefined
\li The Java language version to interpret source code as. If undefined, the compiler
will use its default.
\row
\li runtimeVersion
\li string
+ \li 1.4
\li undefined
\li The version of the Java runtime to generate compatible bytecode for. If undefined,
the compiler will use its default.
\row
\li warningsAsErrors
\li bool
+ \li 1.4
\li \c false
\li If this property is enabled, the compiler will abort where it would normally emit
a warning.
diff --git a/doc/reference/modules/nodejs-module.qdoc b/doc/reference/modules/nodejs-module.qdoc
index 2b1b32347..a19cb72d4 100644
--- a/doc/reference/modules/nodejs-module.qdoc
+++ b/doc/reference/modules/nodejs-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module nodejs
+ \since 1.3
\brief Provides Node.js support.
The \c nodejs module contains support for running \l{http://nodejs.org}{Node.js}
@@ -45,11 +46,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li applicationFile
\li path
+ \li 1.3
\li \c{undefined}
\li The input JavaScript file whose corresponding output will be executed when running the
Node.js application. If this property is \c{undefined}, the product will not be
diff --git a/doc/reference/modules/nsis-module.qdoc b/doc/reference/modules/nsis-module.qdoc
index 7d36c2791..a971b457a 100644
--- a/doc/reference/modules/nsis-module.qdoc
+++ b/doc/reference/modules/nsis-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module nsis
+ \since 1.2
\brief Provides Nullsoft Scriptable Install System support.
The \c nsis module contains properties and rules for building EXE installers
@@ -51,11 +52,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li defines
\li stringList
+ \li 1.2
\li \c{undefined}
\li List of preprocessor macros that get passed to the compiler.
To set macro values, use the following syntax:
@@ -63,12 +66,14 @@
\row
\li disableConfig
\li bool
+ \li 1.2
\li \c{false}
\li Whether to disable inclusion of nsisconf.nsh.
Generally you do not need to set this property.
\row
\li enableQbsDefines
\li bool
+ \li 1.2
\li \c{true}
\li Whether to define preprocessor macros corresponding to values from the project and
product objects. When building a 64-bit package, the preprocessor variable \c{Win64}
@@ -76,6 +81,7 @@
\row
\li warningLevel
\li string
+ \li 1.2
\li \c{"normal"}
\li Severity of warnings to emit. The higher the level, the more warnings will be shown.
The levels \c{none}, \c{errors}, \c{warnings}, \c{info} and \c{all} correspond to NSIS
@@ -83,11 +89,13 @@
\row
\li compilerFlags
\li stringList
+ \li 1.2
\li undefined
\li Additional flags for the NSIS compiler.
\row
\li compressor
\li string
+ \li 1.2
\li \c{"default"}
\li Compression algorithm used to compress files and data in the installer.
Setting this property overrides any SetCompressor command in the NSI file being
@@ -96,48 +104,57 @@
\row
\li version
\li string
+ \li 1.2
\li \c{undefined}
\li The NSIS version. Consists of four numbers separated by dots, for instance "2.46.0.0".
\row
\li versionMajor
\li int
+ \li 1.2
\li \c{versionParts[0]}
\li The NSIS major version.
\row
\li versionMinor
\li int
+ \li 1.2
\li \c{versionParts[1]}
\li The NSIS minor version.
\row
\li versionParts
\li list
+ \li 1.2
\li \c{empty}
\li The NSIS version as a list. For instance, NSIS version 2.46.0.0 would correspond to a
value of \c[2, 46, 0, 0].
\row
\li versionPatch
\li int
+ \li 1.2
\li \c{versionParts[2]}
\li The NSIS patch level.
\row
\li versionBuild
\li int
+ \li 1.2
\li \c{versionParts[3]}
\li The fourth NSIS version number component.
\row
\li toolchainInstallPath
\li path
+ \li 1.2
\li determined automatically
\li NSIS installation directory. Determined by searching known registry keys and known
installation paths until a match is found. This should not normally need to be changed.
\row
\li compilerName
\li string
+ \li 1.2
\li \c{"makensis"}
\li Name of the compiler binary. This should not normally need to be changed.
\row
\li compilerPath
\li string
+ \li 1.2
\li \c{compilerName}
\li Directory where the compiler binary is located. This should not normally need to be
changed.
diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index 576102244..3083e84b9 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module qbs
+ \since 1.0
\brief Comprises general properties.
The \c qbs module is implicitly loaded in every product. It contains properties of the current
@@ -45,33 +46,39 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li buildVariant
\li \c{string}
+ \li 1.0
\li \c{"debug"}
\li Contains the name of the build variant for the current build.
\row
\li debugInformation
\li \c bool
+ \li 1.0
\li \c{true} for debug builds, \c{false} otherwise
\li Specifies whether to generate debug information.
\row
\li enableDebugCode
\li \c bool
+ \li 1.0
\li \c{true} for debug builds, \c{false} otherwise
\li Specifies whether to compile debug code in the product.
This is typically enabled for debug builds and disabled for release builds.
\row
\li optimization
\li \c{string}
+ \li 1.0
\li \c{"none"} for debug builds, \c{"fast"} for release builds
\li Specifies the general type of optimization that should be performed by all toolchains.
Allowed values: \c{"none"}, \c{"fast"}, \c{"small"}
\row
\li targetOS
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li Specifies the OS you want to build the project for. This is typically set in a profile.
Possible values include one or more of the following:
@@ -119,6 +126,7 @@
\row
\li architecture
\li \c{string}
+ \li 1.0
\li \c{undefined}
\li Specifies the target platform's processor architecture.
This is typically set in a profile.
@@ -126,18 +134,21 @@
\row
\li toolchain
\li \c{stringList}
+ \li 1.0
\li \c{undefined}
\li Specifies the attributes of the toolchain that is going to be used for this build.
Typical values include: \c{"gcc"}, \c{"llvm"}, \c{"clang"}, \c{"mingw"}, \c{"msvc"}
\row
\li sysroot
\li \c{string}
+ \li 1.0
\li \c{undefined}
\li Specifies the sysroot of the target platform.
This property is typically set in a profile for cross-compiling.
\row
\li pathListSeparator
\li \c{string}
+ \li 1.0
\li \c{";"} on Windows,
\c{":"} on Unix
\li Holds the platform-specific separator for path list that is used in environment
@@ -153,11 +164,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li hostOS
\li \c{stringList} (read only)
+ \li 1.0
\li \c{undefined}
\li This property is set by \QBS internally and specifies the OS \QBS is running on.
The possible values for this property are the values of \c targetOS, though some may not
@@ -165,6 +178,7 @@
\row
\li hostOSVersion
\li \c{string} (read only)
+ \li 1.2
\li \c{undefined}
\li The host operating system version. Currently only defined for Windows and Apple
platforms. Consists of two or three numbers separated by dots, for instance "10.9" or
@@ -172,6 +186,7 @@
\row
\li hostOSBuildVersion
\li \c{string} (read only)
+ \li 1.2
\li \c{undefined}
\li The host operating system's build version. Currently only defined for Windows and Apple
platforms. On Windows, this is the 4 or 5 digit Windows build number and is equivalent
@@ -180,16 +195,19 @@
\row
\li hostOSVersionMajor
\li \c{int} (read only)
+ \li 1.2
\li \c{hostOSVersionParts[0]}
\li The host operating system major version.
\row
\li hostOSVersionMinor
\li \c{int} (read only)
+ \li 1.2
\li \c{hostOSVersionParts[1]}
\li The host operating system minor version.
\row
\li hostOSVersionParts
\li \c{list} (read only)
+ \li 1.2
\li \c{empty}
\li The host operating system version as a list.
For instance, Windows 8.1 (version 6.3.9600) would correspond to a value of
@@ -197,26 +215,31 @@
\row
\li hostOSVersionPatch
\li \c{int} (read only)
+ \li 1.2
\li \c{hostOSVersionParts[2]}
\li The host operating system patch level.
\row
\li version
\li \c{string} (read only)
+ \li 1.4.1
\li
\li Version number of \QBS as a string, i.e. "1.4.1".
\row
\li versionMajor
\li \c{int} (read only)
+ \li 1.4.1
\li
\li Major version number of \QBS.
\row
\li versionMinor
\li \c{int} (read only)
+ \li 1.4.1
\li
\li Minor version number of \QBS.
\row
\li versionPatch
\li \c{int} (read only)
+ \li 1.4.1
\li
\li Patch version number of \QBS.
\endtable
@@ -230,11 +253,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li install
\li \c{bool}
+ \li 1.0
\li \c{false}
\li Specifies whether to install a certain set of files.
This is typically set in a \c{Group} item to mark a number of files as installable.
@@ -243,6 +268,7 @@
\row
\li installSourceBase
\li \c{string}
+ \li 1.4
\li see below
\li Specifies the base directory of the local files that are going to be installed. The
source base directory is omitted from the target directory path specified in
@@ -251,12 +277,14 @@
\row
\li installDir
\li \c{string}
+ \li 1.0
\li \c{undefined}
\li Specifies the installation directory for the files of a product or a \c{Group}. The
value of this property is a path that is relative to \c installPrefix.
\row
\li installPrefix
\li \c{string}
+ \li 1.1
\li \c{empty}
\li Specifies the global installation prefix. It is implicitly prepended to all values of
\c installDir. The \c installPrefix itself is relative to the \c installRoot in the
@@ -264,6 +292,7 @@
\row
\li installRoot
\li \c{string}
+ \li 1.4
\li \c{<build dir>/install-root}
\li Specifies the global installation root. It is implicitly prepended to all values
of \c installPrefix in the context of installation.
diff --git a/doc/reference/modules/typescript-module.qdoc b/doc/reference/modules/typescript-module.qdoc
index c380642e1..c39d802ab 100644
--- a/doc/reference/modules/typescript-module.qdoc
+++ b/doc/reference/modules/typescript-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module typescript
+ \since 1.3
\brief Provides TypeScript support.
The \c typescript module contains properties and rules for building
@@ -46,11 +47,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li warningLevel
\li \c{string}
+ \li 1.3
\li \c{"normal"}
\li Severity of warnings to emit. The higher the level, the more warnings will be shown.
\c{pedantic} causes the TypeScript to emit warnings on expressions and declarations with
@@ -58,6 +61,7 @@
\row
\li targetVersion
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li ECMAScript target version for generated JavaScript code. \c{undefined} uses the
TypeScript
@@ -65,6 +69,7 @@
\row
\li moduleLoader
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li If TypeScript modules are being used, the JavaScript module loading mechanism to use in
the generated JavaScript code. \c{undefined} indicates modules are not being used.
@@ -73,27 +78,32 @@
\row
\li stripComments
\li \c{bool}
+ \li 1.3
\li \c{!qbs.debugInformation}
\li Whether to remove comments from the generated JavaScript files.
\row
\li generateDeclarations
\li \c{bool}
+ \li 1.3
\li \c{false}
\li Whether to generate corresponding .d.ts files during compilation; these are TypeScript's
equivalent of header files.
\row
\li generateSourceMaps
\li \c{bool}
+ \li 1.3
\li \c{qbs.debugInformation}
\li Whether to generate corresponding .map files during compilation.
\row
\li compilerFlags
\li \c{stringList}
+ \li 1.3
\li \c{undefined}
\li Additional flags for the TypeScript compiler.
\row
\li singleFile
\li \c{bool}
+ \li 1.3
\li \c{false}
\li Whether to compile all TypeScript source files to a single JavaScript output file. The
default is to compile each TypeScript file to a corresponding JavaScript file. This
@@ -101,49 +111,58 @@
\row
\li version
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li The TypeScript version. Consists of four numbers separated by dots, for instance
"1.0.0.0".
\row
\li versionMajor
\li \c{int}
+ \li 1.3
\li \c{versionParts[0]}
\li The TypeScript major version.
\row
\li versionMinor
\li \c{int}
+ \li 1.3
\li \c{versionParts[1]}
\li The TypeScript minor version.
\row
\li versionParts
\li \c{list}
+ \li 1.3
\li \c{empty}
\li The TypeScript version as a list. For instance, TypeScript version 1.0 would correspond
to a value of \c[1, 0, 0, 0].
\row
\li versionPatch
\li \c{int}
+ \li 1.3
\li \c{versionParts[2]}
\li The TypeScript patch level.
\row
\li versionBuild
\li \c{int}
+ \li 1.3
\li \c{versionParts[3]}
\li The fourth TypeScript version number component.
\row
\li toolchainInstallPath
\li \c{path}
+ \li 1.3
\li \c{undefined}
\li TypeScript installation directory. This should not normally need to be changed provided
that \c{tsc} is already available by searching the PATH environment variable.
\row
\li compilerName
\li \c{string}
+ \li 1.3
\li \c{"tsc"}
\li Name of the compiler binary. This should not normally need to be changed.
\row
\li compilerPath
\li \c{string}
+ \li 1.3
\li \c{compilerName}
\li Directory where the compiler binary is located.
This should not normally need to be changed.
diff --git a/doc/reference/modules/wix-module.qdoc b/doc/reference/modules/wix-module.qdoc
index 2352ca5d6..939e92dc1 100644
--- a/doc/reference/modules/wix-module.qdoc
+++ b/doc/reference/modules/wix-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module wix
+ \since 1.2
\brief Provides Windows Installer XML Toolset support.
The \c wix module contains properties and rules for building MSI and
@@ -47,16 +48,19 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li debugInformation
\li \c{bool}
+ \li 1.2
\li \c{qbs.debugInformation}
\li Generate debug information. See \c{qbs.debugInformation}.
\row
\li defines
\li \c{stringList}
+ \li 1.2
\li \c{undefined}
\li List of preprocessor macros that get passed to the compiler.
To set macro values use the following syntax:
@@ -64,6 +68,7 @@
\row
\li enableQbsDefines
\li \c{bool}
+ \li 1.2
\li \c{true}
\li Whether to define preprocessor macros corresponding to values from the project and
product objects. When building a 64-bit package, the preprocessor variable \c{Win64}
@@ -71,50 +76,59 @@
\row
\li visualStudioCompatibility
\li \c{bool}
+ \li 1.2
\li \c{true}
\li Passes most of the same preprocessor macros to the compiler as Visual Studio does.
This allows easier authoring WiX files that are compatible with both \QBS and MSBuild.
\row
\li includePaths
\li \c{pathList}
+ \li 1.2
\li \c{undefined}
\li List of include paths. Relative paths are considered to be relative to the .qbs product
file they are used in.
\row
\li treatWarningsAsErrors
\li \c{bool}
+ \li 1.2
\li \c{false}
\li Warnings will be handled as errors and cause the build to fail.
\row
\li warningLevel
\li \c{string}
+ \li 1.2
\li \c{"normal"}
\li Severity of warnings to emit. The higher the level, the more warnings will be shown.
Possible values include: \c{"none"}, \c{"normal"}, \c{"pedantic"}
\row
\li verboseOutput
\li \c{bool}
+ \li 1.2
\li \c{false}
\li Whether to display verbose output from the compiler and linker.
\row
\li compilerFlags
\li \c{stringList}
+ \li 1.2
\li \c{undefined}
\li Additional flags for the Candle compiler.
\row
\li linkerFlags
\li \c{stringList}
+ \li 1.2
\li \c{undefined}
\li Additional flags for the Light linker.
\row
\li cultures
\li \c{stringList}
+ \li 1.2
\li \c{undefined}
\li List of localizations to include in the MSI.
Use \c{undefined} to include all localizations.
\row
\li extensions
\li \c{stringList}
+ \li 1.2
\li \c{["WixBalExtension"]} if the product type is an EXE setup application,
otherwise \c{undefined}.
\li List of extension assemblies to link into the output.
@@ -139,67 +153,79 @@
\row
\li version
\li \c{string}
+ \li 1.2
\li \c{undefined}
\li The WiX version. Consists of four numbers separated by dots, for instance "3.7.1224.0".
\row
\li versionMajor
\li \c{int}
+ \li 1.2
\li \c{versionParts[0]}
\li The WiX major version.
\row
\li versionMinor
\li \c{int}
+ \li 1.2
\li \c{versionParts[1]}
\li The WiX minor version.
\row
\li versionParts
\li \c{list}
+ \li 1.2
\li \c{empty}
\li The WiX version as a list. For instance, WiX version 3.7.1224.0 would correspond to a
value of \c[3, 7, 1224, 0].
\row
\li versionPatch
\li \c{int}
+ \li 1.2
\li \c{versionParts[2]}
\li The WiX patch level.
\row
\li versionBuild
\li \c{int}
+ \li 1.2
\li \c{versionParts[3]}
\li The fourth WiX version number component.
\row
\li toolchainInstallPath
\li \c{path}
+ \li 1.2
\li determined automatically
\li WiX installation directory. Determined by searching the registry for the latest version.
This should not normally need to be changed.
\row
\li toolchainInstallRoot
\li \c{path}
+ \li 1.2
\li determined automatically
\li WiX binaries directory. Determined by searching the registry for the latest version.
This should not normally need to be changed.
\row
\li compilerName
\li \c{string}
+ \li 1.2
\li \c{"candle.exe"}
\li Name of the compiler binary.
This should not normally need to be changed.
\row
\li compilerPath
\li \c{string}
+ \li 1.2
\li \c{compilerName}
\li Directory where the compiler binary is located.
This should not normally need to be changed.
\row
\li linkerName
\li \c{string}
+ \li 1.2
\li \c{"light.exe"}
\li Name of the linker binary.
This should not normally need to be changed.
\row
\li linkerPath
\li \c{string}
+ \li 1.2
\li \c{linkerName}
\li Directory where the linker binary is located.
This should not normally need to be changed.