From ded7a6ed863180a1a11becfed21161b9ab22bf99 Mon Sep 17 00:00:00 2001 From: bjorn3 <17426603+bjorn3@users.noreply.github.com> Date: Sun, 6 Jul 2025 15:30:05 +0200 Subject: [PATCH] graphics/graphics-ipc: Update handle doc comments --- graphics/graphics-ipc/src/v1.rs | 2 ++ graphics/graphics-ipc/src/v2.rs | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/graphics/graphics-ipc/src/v1.rs b/graphics/graphics-ipc/src/v1.rs index a29258db9c..640d117bab 100644 --- a/graphics/graphics-ipc/src/v1.rs +++ b/graphics/graphics-ipc/src/v1.rs @@ -11,6 +11,8 @@ pub use crate::common::DisplayMap; /// /// The v1 graphics API only allows a single framebuffer for each VT, requires each display to be /// handled separately and doesn't support page flipping. +/// +/// This API is stable. No breaking changes are allowed to be made without a version bump. pub struct V1GraphicsHandle { file: File, } diff --git a/graphics/graphics-ipc/src/v2.rs b/graphics/graphics-ipc/src/v2.rs index fa316d96b0..689e865bc2 100644 --- a/graphics/graphics-ipc/src/v2.rs +++ b/graphics/graphics-ipc/src/v2.rs @@ -33,10 +33,13 @@ unsafe fn sys_call( )) } -/// A graphics handle using the (currently unstable) v2 graphics API. +/// A graphics handle using the v2 graphics API. /// /// The v2 graphics API allows creating framebuffers on the fly, using them for page flipping and /// handles all displays using a single fd. +/// +/// This API is not yet stable. Do not depend on it outside of the drivers repo until it has been +/// stabilized. pub struct V2GraphicsHandle { file: File, }