From 711efcae5567245405568fbb2003a3a0a7f4fac7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B8ger=20Hanseg=C3=A5rd?= Date: Mon, 14 Aug 2023 10:23:22 +0200 Subject: [PATCH] [Doc] Clarify caller expectations for IPC Cross-platform safe key format Clarify that Qt will silently truncate oversized keys for QSystemSemaphore and QSharedMemory. This can have implications for some use-cases, for example if an absolute path file name is used as a key name to synchronize access to files. Change-Id: I74742d11fd72139ff69d033e611904dcf0e9e822 Reviewed-by: Thiago Macieira --- src/corelib/doc/src/ipc.qdoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/corelib/doc/src/ipc.qdoc b/src/corelib/doc/src/ipc.qdoc index 983439a436a..3c86662c280 100644 --- a/src/corelib/doc/src/ipc.qdoc +++ b/src/corelib/doc/src/ipc.qdoc @@ -274,7 +274,10 @@ file names, in particular those that separate path components (slash and backslash), with the exception of sandboxed applications on Apple operating systems. The following are good examples of cross-platform keys: "myapp", - "org.example.myapp", "org.example.myapp-12345". + "org.example.myapp", "org.example.myapp-12345". Note that it is up to the + caller to prevent oversized keys, and to ensure that the key contains legal + characters on the respective platform. Qt will silently truncate keys that + are too long. \b{Apple sandbox limitations:} if the application is running inside of a sandbox in an Apple operating system, the key must be in a very specific