From 595b37848ead3d63b897ce9193aa231aa3aa87b0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20Br=C3=BCning?= <michael.bruning@qt.io>
Date: Wed, 17 May 2023 14:56:26 +0200
Subject: [macos] Improve documentation for deploying applications on macos

Add information on camera and microphone usage description and enabling
microphone and camera access for notarized applications.

Pick-to: 6.5
Task-number: QTBUG-113524
Change-Id: I285103652a7d977c3d2fb8b0e3d393cbff77c219
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Michal Klocek <michal.klocek@qt.io>
---
 src/core/doc/src/qtwebengine-deploying.qdoc | 43 +++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/src/core/doc/src/qtwebengine-deploying.qdoc b/src/core/doc/src/qtwebengine-deploying.qdoc
index 3fb46a672..7504965e3 100644
--- a/src/core/doc/src/qtwebengine-deploying.qdoc
+++ b/src/core/doc/src/qtwebengine-deploying.qdoc
@@ -138,4 +138,47 @@
     QTQUICK_COMPILER_SKIPPED_RESOURCES += resources/my_resource.qrc
     \endcode
 
+    \section2 \macos Specific Deployment Steps
+
+    To deploy a \QWE application that accesses the microphone or camera
+    on \macos, you will need to provide texts for the messages that will be shown to the user to
+    explain why the application asks for permission to access to the camera or microphone.
+    To do this, add the texts to the application's \c Info.plist file using the keys
+    described below.
+
+    For the camera usage message, provide a text using the following key:
+    \code
+    <key>NSCameraUsageDescription</key>
+    <string>Your message text for camera usage.</string>
+    \endcode
+
+    \sa \l{https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription} {Apple's property list file documentation}
+
+    For the microphone usage message, provide a text using the following key:
+    \code
+    <key>NSMicrophoneUsageDescription</key>
+    <string>Your message text for microphone usage.</string>
+    \endcode
+
+    \sa \l{https://developer.apple.com/documentation/bundleresources/information_property_list/nsmicrophoneusagedescription} {Apple's property list file documentation}
+
+    To notarize an application that accesses the camera or the microphone,
+    you will need to add the corresponding keys to your application's entitlements file used for
+    deployment and notarization.
+
+    To enable access to the camera, add:
+    \code
+    <key>com.apple.security.device.camera</key>
+    <true/>
+    \endcode
+
+    \sa \l{https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_camera} {Apple's camera entitlement documentation}.
+
+    To enable access to the microphone, add:
+    \code
+    <key>com.apple.security.device.microphone</key>
+    <true/>
+    \endcode
+
+    /sa \l{https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_microphone} {Apple's microphone entitlement documentation}.
 */
-- 
cgit v1.2.3