diff options
author | Ivan Komissarov <abbapoh@gmail.com> | 2020-07-29 18:54:37 +0200 |
---|---|---|
committer | Ivan Komissarov <ABBAPOH@gmail.com> | 2020-07-31 11:10:35 +0000 |
commit | ed1536c6f882be505642cf1f2b191ef53d8dee31 (patch) | |
tree | 1c865bed2903a2500ca718b80780422021573496 | |
parent | 8ee19f3d8fcc83053e856ddf769b437d233b72d1 (diff) | |
download | qbs-ed1536c6f882be505642cf1f2b191ef53d8dee31.tar.gz |
doc: Document more cpp module properties
Fixes: QBS-1304
Change-Id: Ie7d2c4827119dbdc6c807c56912431fb3111f712
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r-- | doc/reference/modules/cpp-module.qdoc | 122 | ||||
-rw-r--r-- | share/qbs/modules/cpp/CppModule.qbs | 7 |
2 files changed, 126 insertions, 3 deletions
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc index f5f43f0f9..e92359377 100644 --- a/doc/reference/modules/cpp-module.qdoc +++ b/doc/reference/modules/cpp-module.qdoc @@ -365,6 +365,15 @@ */ /*! + \qmlproperty bool cpp::createSymlinks + \unixproperty + + Whether to create version alias symlinks when building a dynamic library. + + \defaultvalue \c true +*/ + +/*! \qmlproperty bool cpp::discardUnusedData \since Qbs 1.10 @@ -516,6 +525,100 @@ */ /*! + \qmlproperty string cpp::executablePrefix + + A string to prepend to the executable file \l{Product::targetName}{name}. + + \defaultvalue \c "" +*/ + +/*! + \qmlproperty string cpp::dynamicLibraryPrefix + + A string to prepend to the dynamic library file \l{Product::targetName}{name}. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c "" or \c "lib" +*/ + +/*! + \qmlproperty string cpp::loadableModulePrefix + \appleproperty + + A string to prepend to the Darwin loadable module file \l{Product::targetName}{name}. + + \defaultvalue \c "" +*/ + +/*! + \qmlproperty string cpp::staticLibraryPrefix + + A string to prepend to the static library file \l{Product::targetName}{name}. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c "" or \c "lib" +*/ + +/*! + \qmlproperty string cpp::executableSuffix + + A string to append to the executable file \l{Product::targetName}{name}. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c "" or \c ".exe" +*/ + +/*! + \qmlproperty string cpp::dynamicLibrarySuffix + + A string to append to the dynamic library file \l{Product::targetName}{name}. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c ".so", \c ".dll" + or \c "dylib" +*/ + +/*! + \qmlproperty string cpp::dynamicLibraryImportSuffix + \windowsproperty + + A string to append to the dynamic library import file \l{Product::targetName}{name}. + + \defaultvalue \c ".lib" +*/ + +/*! + \qmlproperty string cpp::loadableModuleSuffix + \appleproperty + + A string to append to the Darwin loadable module file \l{Product::targetName}{name}. + + \defaultvalue \c ".bundle" +*/ + +/*! + \qmlproperty string cpp::staticLibrarySuffix + + A string to append to the executable file \l{Product::targetName}{name}. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c ".a" or \c ".lib" +*/ + +/*! + \qmlproperty string cpp::debugInfoSuffix + + A string to append to the debug information file name. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c ".debug", + \c ".pdb" or \c ".dwarf" +*/ + +/*! + \qmlproperty string cpp::debugInfoBundleSuffix + \appleproperty + + A string to append to the debug information bundle name. + + \defaultvalue \c ".dSYM" +*/ + +/*! \qmlproperty pathList cpp::prefixHeaders \since Qbs 1.0.1 @@ -949,6 +1052,15 @@ */ /*! + \qmlproperty bool cpp::enableSuspiciousLinkerFlagWarnings + \since Qbs 1.8 + + Whether to print warnings about escaped linker flags (such as \c -Xlinker and \c -Wl). + + \defaultvalue \c{true} +*/ + +/*! \qmlproperty string cpp::exceptionHandlingModel \since Qbs 1.5 @@ -1449,6 +1561,16 @@ */ /*! + \qmlproperty string cpp::rpathLinkFlag + \since Qbs 1.9 + + The rpath link flag used by the linker. + + \defaultvalue \l{qbs::toolchain}{toolchain}-dependent, typical values are \c "-rpath-link=" + or \c "-L" +*/ + +/*! \qmlproperty string cpp::variantSuffix \since Qbs 1.10 diff --git a/share/qbs/modules/cpp/CppModule.qbs b/share/qbs/modules/cpp/CppModule.qbs index 173c3f3e5..b2897c30c 100644 --- a/share/qbs/modules/cpp/CppModule.qbs +++ b/share/qbs/modules/cpp/CppModule.qbs @@ -128,7 +128,7 @@ Module { defaults will be used." } - property string minimumAndroidVersion + property string minimumAndroidVersion // not used, undocumented PropertyOptions { name: "minimumAndroidVersion" description: "a version number in the format [major].[minor] indicating the earliest \ @@ -136,7 +136,7 @@ Module { version which is then written to AndroidManifest.xml." } - property string maximumAndroidVersion + property string maximumAndroidVersion // not used, undocumented PropertyOptions { name: "maximumAndroidVersion" description: "a version number in the format [major].[minor] indicating the latest \ @@ -384,13 +384,14 @@ Module { property bool combineObjcSources: false property bool combineObjcxxSources: false + // Those are set internally by different cpp module implementations property stringList targetAssemblerFlags property stringList targetDriverFlags property stringList targetLinkerFlags property bool _skipAllChecks: false // Internal - property bool validateTargetTriple: true + property bool validateTargetTriple: true // undocumented // TODO: The following four rules could use a convenience base item if rule properties // were available in Artifact items and prepare scripts. |