diff options
author | Alexandru Croitor <alexandru.croitor@qt.io> | 2022-08-11 18:43:09 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-31 08:07:28 +0000 |
commit | 0ec5393b55689ae3b262e9b37e2474933141abd4 (patch) | |
tree | 6699bb94a535ccac0d69e6cb4aa2626ecf7bb2de | |
parent | d5dd5ee00ac9159deb21c98a13f53ac9dfe11a6a (diff) | |
download | qtdoc-0ec5393b55689ae3b262e9b37e2474933141abd4.tar.gz |
CMake: Mention how to make an iOS application a bundle
Fixes: QTBUG-104519
Change-Id: Ied29d7199a6d4be53224104a881608201c05b53b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit bafc293a08b956ab6f07a0d5c4bdb819fc02c3b0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | doc/src/platforms/apple-app-bundle.qdocinc | 18 | ||||
-rw-r--r-- | doc/src/platforms/ios.qdoc | 9 | ||||
-rw-r--r-- | doc/src/platforms/macos.qdoc | 6 |
3 files changed, 28 insertions, 5 deletions
diff --git a/doc/src/platforms/apple-app-bundle.qdocinc b/doc/src/platforms/apple-app-bundle.qdocinc new file mode 100644 index 00000000..10b6c5c2 --- /dev/null +++ b/doc/src/platforms/apple-app-bundle.qdocinc @@ -0,0 +1,18 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +//! [building an app bundle] + To build your application as an application bundle with CMake, set the + \l {https://cmake.org/cmake/help/latest/prop_tgt/MACOSX_BUNDLE.html} + {\c {MACOSX_BUNDLE}} property on your executable target, as follows: + + \badcode + qt_add_executable(app) + if(APPLE) + set_target_properties(tst_manual_ios_assets PROPERTIES MACOSX_BUNDLE TRUE) + endif() + \endcode + + With qmake, bundles are the default. Set \c {CONFIG -= app_bundle} in your project + file (\c{.pro}) to disable it. +//! [building an app bundle] diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc index 9f70dee3..a0aaf54c 100644 --- a/doc/src/platforms/ios.qdoc +++ b/doc/src/platforms/ios.qdoc @@ -290,6 +290,15 @@ Checking that the application is configured correctly is especially important before submitting an application for publishing in Apple's App Store. + \section2 Application bundles + + iOS applications are typically deployed as self-contained application + bundles. The application bundle contains the application's executable as well + as dependencies, such as the Qt libraries, plugins, translations, and other + resources the application may need. + + \include {apple-app-bundle.qdocinc} {building an app bundle} + \target Info.plist \section2 Information Property List Files diff --git a/doc/src/platforms/macos.qdoc b/doc/src/platforms/macos.qdoc index 4cb3c4e1..03f78816 100644 --- a/doc/src/platforms/macos.qdoc +++ b/doc/src/platforms/macos.qdoc @@ -184,11 +184,7 @@ resources you may need. Third party libraries like Qt are normally not installed system-wide; each application provides its own copy. - To build your application as an application bundle with CMake, set the - \l {https://cmake.org/cmake/help/latest/prop_tgt/MACOSX_BUNDLE.html} - {\c {MACOSX_BUNDLE}} property on your executable target. With qmake, - bundles are the default. Set \c {CONFIG -= app_bundle} in your project - file (\c{.pro}) to disable it. + \include {apple-app-bundle.qdocinc} {building an app bundle} A common way to distribute applications is to provide a compressed disk image (.dmg file) that the user can mount in Finder. The deployment tool, \c |