From a023a0db09cbdc24a024d748a861937645ffa068 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Tue, 3 Jun 2025 07:41:21 +0530 Subject: [PATCH] Graphics protocol: Add a note clarifying image update behavior on re-transmission See #8701 --- docs/changelog.rst | 2 ++ docs/graphics-protocol.rst | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 0217ac128..32c6dc7a6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -121,6 +121,8 @@ Detailed list of changes - Fix a crash when using linear easing curves for animations (:iss:`8692`) +- Graphics protocol: Add a note clarifying image update behavior on re-transmission (:iss:`8701`) + 0.42.1 [2025-05-17] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/graphics-protocol.rst b/docs/graphics-protocol.rst index 1afbaf7e6..1964e4eba 100644 --- a/docs/graphics-protocol.rst +++ b/docs/graphics-protocol.rst @@ -339,7 +339,7 @@ similar to reporting any other kind of I/O error. Since the file paths come from potentially untrusted sources, terminal emulators **must** refuse to read any device/socket/etc. special files. Only regular files are allowed. Additionally, terminal emulators may refuse to read files in *sensitive* -parts of the filesystem, such as :file:`/proc`, :file:`/sys`, :file:`/dev/`, etc. +parts of the filesystem, such as :file:`/proc`, :file:`/sys`, :file:`/dev`, etc. Local client ^^^^^^^^^^^^^^ @@ -483,6 +483,14 @@ second one will replace the first. This can be used to resize or move placements around the screen, without flicker. +.. note:: + When re-transmitting image data for a specific id, the existing image and + all its placements must be deleted. The new data replaces the old image data + but is not actually displayed until a placement for it is created. This is + to avoid divergent behavior in the case when unrelated programs happen to re-use + image ids in the same session. + + .. versionadded:: 0.19.3 Support for specifying placement ids (see :doc:`kittens/query_terminal` to query kitty version)