From 5bb59e74070fdbf12c4b6c943385ef9a480b787c Mon Sep 17 00:00:00 2001
From: Jake Petroules <jake.petroules@qt.io>
Date: Thu, 19 Oct 2017 13:16:37 +0200
Subject: Doc: add a page describing what multiplexing is and how it works

Change-Id: I98415837ff441312333b3b038f3989397f505215
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
---
 doc/qbs.qdoc | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 58 insertions(+), 2 deletions(-)

(limited to 'doc/qbs.qdoc')

diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index 4769933ff..91cd49401 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -66,6 +66,7 @@
                \li  \l{Target Platforms}
                \li  \l{Using the Shell}
                \li  \l{Generators}
+               \li  \l{Multiplexing}
                \li  \l{Custom Modules and Items}
            \endlist
        \li  \l{How-tos}
@@ -685,6 +686,7 @@
         \li  \l{Installing Files}
         \li  \l{Using the Shell}
         \li  \l{Generators}
+        \li  \l{Multiplexing}
         \li  \l{Custom Modules and Items}
     \endlist
 
@@ -1261,7 +1263,7 @@
 
 /*!
     \contentspage index.html
-    \previouspage generators.html
+    \previouspage multiplexing.html
     \page custom-modules.html
     \nextpage howtos.html
 
@@ -1332,7 +1334,7 @@
     \contentspage index.html
     \previouspage shell.html
     \page generators.html
-    \nextpage custom-modules.html
+    \nextpage multiplexing.html
 
     \title Generators
 
@@ -1414,6 +1416,60 @@
     message.
 */
 
+/*!
+    \contentspage index.html
+    \previouspage generators.html
+    \page multiplexing.html
+    \nextpage custom-modules.html
+
+    \title Multiplexing
+
+    Multiplexing is an advanced \QBS feature that allows a product to be
+    transparently built in multiple \e passes along with an optional, final
+    \e aggregate pass that allows the output artifacts of the initial passes
+    to be combined or otherwise operated on in some way.
+
+    The multiplexing feature is used to implement certain platform-specific
+    behavior: specifically, it allows applications and libraries on Apple
+    platforms to be compiled into \e fat binaries containing multiple CPU
+    architectures, the creation of Apple frameworks containing multiple
+    \e variants (for example, combined debug and release builds), and the
+    creation of Android application and library packages containing native
+    code built for multiple Android ABIs.
+
+    A product can be multiplexed over the \c qbs.architectures property (which
+    maps to \c qbs.architecture), \c qbs.buildVariants property (which maps to
+    \c qbs.buildVariant), and \c qbs.profiles (which maps to \c qbs.profile).
+
+    \note The implementation details around multiplexing are subject to change.
+
+    Product multiplexing works by examining a special property on the
+    \l{Product Item}{Product} item called \c multiplexByQbsProperties, which can
+    be set to the list of properties your product should multiplex over. For
+    example, \c multiplexByQbsProperties might contain two strings,
+    \c "architectures" and \c "buildVariants". \QBS evaluates the values of
+    \c qbs.architectures and \c qbs.buildVariants, which in turn might contain
+    the values \c ["x86", "x86_64"] and \c ["debug", "release"]. \QBS will build
+    all the possible configurations of the product: \c {(x86, debug)},
+    \c {(x86, release)}, \c {(x86_64, debug)}, and \c {(x86_64, release)}.
+
+    If the product’s \c aggregate property is \c true, the product will also be
+    built a fifth time, with the values of the multiplexed properties left
+    undefined. The aggregate product will have an automatic dependency on the
+    original four instances of the product, allowing it to collect their output
+    artifacts and to operate on them.
+
+    The aggregate product is used in situations where the target artifacts of
+    the individually multiplexed instances must be combined into one final
+    aggregate artifact that makes up the overall product.
+    Bundle products on Apple platforms use the aggregate product to create the
+    bundle artifacts (such as \c Info.plist and \c PkgInfo) that are independent
+    of a particular architecture or build variant. In addition, they use the
+    \c lipo tool to join together the built native code for different
+    architectures (such as \c x86 and \c x86_64) into the final,
+    multi-architecture fat binary that the app bundle contains.
+*/
+
 /*!
     \contentspage index.html
     \previouspage porting-to-qbs.html
-- 
cgit v1.2.3