[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 <thiago.macieira@intel.com>
This commit is contained in:
Jøger Hansegård 2023-08-14 10:23:22 +02:00
parent 9c1d20337a
commit 711efcae55

View File

@ -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