From 35b3d25ee125da0bdea9a8b30c9e8f30a0940253 Mon Sep 17 00:00:00 2001 From: "trop[bot]" <37223003+trop[bot]@users.noreply.github.com> Date: Mon, 11 Aug 2025 09:43:30 +0200 Subject: [PATCH] docs: deprecate `ELECTRON_OZONE_PLATFORM_HINT` env var (#48028) Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: clavin --- docs/api/environment-variables.md | 6 +++--- docs/breaking-changes.md | 8 ++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index f0efc56404ac..cbd3525d03e1 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -125,13 +125,13 @@ Options: * `kioclient5` * `kioclient` -### `ELECTRON_OZONE_PLATFORM_HINT` _Linux_ +### `ELECTRON_OZONE_PLATFORM_HINT` _Linux_ _Deprecated_ -Selects the preferred platform backend used on Linux. The default one is `x11`. `auto` selects Wayland if possible, X11 otherwise. +Selects the preferred platform backend used on Linux. `auto` selects Wayland if possible, X11 otherwise. Options: -* `auto` +* `auto` (Default) * `wayland` * `x11` diff --git a/docs/breaking-changes.md b/docs/breaking-changes.md index 7137988a2994..b61f2d9576b6 100644 --- a/docs/breaking-changes.md +++ b/docs/breaking-changes.md @@ -14,6 +14,14 @@ This document uses the following convention to categorize breaking changes: ## Planned Breaking API Changes (38.0) +### Deprecated: `ELECTRON_OZONE_PLATFORM_HINT` environment variable + +The default value of the `--ozone-plaftform` flag [changed to `auto`](https://chromium-review.googlesource.com/c/chromium/src/+/6775426). + +You should use the `XDG_SESSION_TYPE=wayland` environment variable instead to use Wayland. + +This environment variable will be [removed soon](https://chromium-review.googlesource.com/c/chromium/src/+/6819616). + ### Removed: macOS 11 support macOS 11 (Big Sur) is no longer supported by [Chromium](https://chromium-review.googlesource.com/c/chromium/src/+/6594615).