From f8b3b3513405efe41cdd159b950ccdd2d39ed536 Mon Sep 17 00:00:00 2001 From: Christian Duerr Date: Mon, 3 Jun 2024 13:43:20 +0200 Subject: [PATCH] Update documentation --- wayland-backend/CHANGELOG.md | 8 ++++++-- wayland-backend/src/sys/mod.rs | 6 +++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/wayland-backend/CHANGELOG.md b/wayland-backend/CHANGELOG.md index 2066b25df7f..433ada7baa6 100644 --- a/wayland-backend/CHANGELOG.md +++ b/wayland-backend/CHANGELOG.md @@ -2,9 +2,13 @@ ## Unreleased +#### Additions + +- `Backend::manage_object` for handling foreign proxies with the sys backend + ## 0.3.4 -- 2024-05-30 -### Additions +#### Additions - Add `rwh_06` feature for `raw-window-handle` 0.6 @@ -14,7 +18,7 @@ ## 0.3.3 -- 2024-01-29 -### Additions +#### Additions - client: Implement `Eq` for `Backend` #### Bugfixes diff --git a/wayland-backend/src/sys/mod.rs b/wayland-backend/src/sys/mod.rs index 2c66db6c674..da14281f4d1 100644 --- a/wayland-backend/src/sys/mod.rs +++ b/wayland-backend/src/sys/mod.rs @@ -101,7 +101,11 @@ impl client::Backend { /// # Safety /// /// There must never be more than one party managing an object. This is only - /// safe to call when a third party is transferring ownership of the proxy. + /// safe to call when a third party gave you ownership of an uninitialized + /// proxy. + /// + /// The caller is also responsible for making sure the passed interface matches + /// the proxy. #[inline] pub unsafe fn manage_object( &self,