From e6e9fa99cc17dd0713d6412b7f74179980f08492 Mon Sep 17 00:00:00 2001
From: Ivan Komissarov <ABBAPOH@gmail.com>
Date: Wed, 8 May 2019 22:41:44 +0200
Subject: doc: Reorganize qbs.targetOS and qbs.targetPlatform

Move conditional examples to the targetOS property.
Add small example about targetPlatform itself.

Task-number: QBS-1426
Change-Id: Ia66dfb18c332e220c1359419202f97c974357363
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
---
 doc/reference/modules/qbs-module.qdoc | 54 +++++++++++++++++++----------------
 1 file changed, 30 insertions(+), 24 deletions(-)

(limited to 'doc/reference/modules/qbs-module.qdoc')

diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index 31e0e6ffe..c354f0419 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -182,32 +182,15 @@
     where the target OS is always known (such as an Apple Watch app written in
     native code).
 
-    You should generally treat this property as \e{write-only} and avoid using
-    it to test for the current target OS. Instead, use the \l{qbs::}{targetOS}
-    property for conditionals. For example, instead of:
-
-    \code
-    qbs.targetPlatform === "macos" || qbs.targetPlatform === "ios" || qbs.targetPlatform === "tvos" || qbs.targetPlatform === "watchos"
-    \endcode
-
-    use
-
+    For example, a profile used for building for the iOS Simulator platform will have this
+    property set to the \c ios-simulator value:
     \code
-    qbs.targetOS.contains("darwin")
-
+        profiles.xcode-iphonesimulator.qbs.targetPlatform: "ios-simulator"
     \endcode
 
-    However, in some cases using \c targetPlatform would be acceptable, such as
-    when the resulting condition would be simpler while still being correct:
-
-    \code
-    qbs.targetPlatform === "linux"
-    \endcode
-
-    versus
-    \code
-    qbs.targetOS.contains("linux") && !qbs.targetOS.contains("android")
-    \endcode
+    You should generally treat this property as \e{write-only} and avoid using
+    it to test for the current target OS. Instead, use the \l{qbs::}{targetOS}
+    property for conditionals.
 
     \section2 Relation between targetPlatform and targetOS
 
@@ -506,7 +489,30 @@
             files: ...
         }
     \endcode
-    Avoid using \l{qbs::}{targetPlatform} for this purpose.
+    Avoid using \l{qbs::}{targetPlatform} for this purpose. For example, instead of:
+
+    \code
+    qbs.targetPlatform === "macos" || qbs.targetPlatform === "ios" || qbs.targetPlatform === "tvos" || qbs.targetPlatform === "watchos"
+    \endcode
+
+    use
+
+    \code
+    qbs.targetOS.contains("darwin")
+
+    \endcode
+
+    However, in some cases using \l{qbs::}{targetPlatform} would be acceptable, such as
+    when the resulting condition would be simpler while still being correct:
+
+    \code
+    qbs.targetPlatform === "linux"
+    \endcode
+
+    versus
+    \code
+    qbs.targetOS.contains("linux") && !qbs.targetOS.contains("android")
+    \endcode
 
     For the complete list of possible values, see
     \l{Relation between targetPlatform and targetOS}.
-- 
cgit v1.2.3