mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-18 14:48:34 +01:00
docs(linux): paths and links name the consolidated layout
The KDE docs were moved from komorebi-for-kde/ to docs/linux/ and the sources, nix files, scripts and schemas to komorebi-linux/, nix/linux/, scripts/linux/ and schemas/linux/, so every relative link that left docs/ (to sources, nix files, scripts, schemas, .envrc, rust-toolchain.toml, the old CI file) was broken, and the text named the old paths. Links were rewritten mechanically by resolving each broken target against the old location and mapping it to the new one; link texts and code-span paths were updated to the new paths (komorebi/src -> komorebi-linux/src, nix/ -> nix/linux/, scripts/ -> scripts/linux/, docs/ -> docs/linux/, schema.json -> schemas/linux/schema.json). The crate list of the README names komorebi-linux, komorebi-daemon and komorebi-version; `cargo install --path komorebi` becomes komorebi-daemon; the comparison paragraph of CONTRIBUTING.md says compare-gen.py is stale (it looks for the old sibling trees). URLs of the old GitHub repositories are left as they are (a release decision). COMPARE.md is left as it is (already marked stale). Verified: a link checker over every markdown file (outside cli/, nix/, tools/, old-ci) reports no broken link in docs/linux. Nothing was built.
This commit is contained in:
1 parent
5b2381efb4
commit
a7b78cc7e4
20 files changed
+358
-355
No files matched your search
+19
-19
@@ -295,7 +295,7 @@ window in the task manager would leave the monitor showing the parking desktop,
|
||||
on it but hidden windows. The table sends the monitor straight back to the desktop it showed
|
||||
before, and the window's own focus change then brings it to the front of its stack.
|
||||
|
||||
komorebi keeps a table of the windows it hid, [`HIDDEN_WINDOWS`](../../komorebi/src/lib.rs), and
|
||||
komorebi keeps a table of the windows it hid, [`HIDDEN_WINDOWS`](../../../komorebi-linux/src/lib.rs), and
|
||||
records a window in it before it asks the backend to hide it. What the compositor reports about a
|
||||
hidden window (a minimize, a move to another desktop) is the echo of a command komorebi sent, and
|
||||
the window manager has to be able to tell that from the user's own: a window that the user
|
||||
@@ -304,9 +304,9 @@ minimizes leaves the layout, and one komorebi hid does not.
|
||||
## Why is the monocle container not one of the containers?
|
||||
|
||||
Because a layout gives every container a tile, and the monocle container is the one that has the
|
||||
whole work area. [`Workspace::new_monocle_container`](../../komorebi/src/workspace.rs) takes the
|
||||
whole work area. [`Workspace::new_monocle_container`](../../../komorebi-linux/src/workspace.rs) takes the
|
||||
focused container out of the workspace's containers and remembers its index, and
|
||||
[`Workspace::update`](../../komorebi/src/workspace.rs) puts the window of the monocle container on
|
||||
[`Workspace::update`](../../../komorebi-linux/src/workspace.rs) puts the window of the monocle container on
|
||||
the work area and gives the other containers no tile. The container is taken out and put back
|
||||
with the plain remove and insert of the ring, and not the ones that respect locked containers:
|
||||
the comments of the code say that a monocle, like a maximize, takes over the whole screen before
|
||||
@@ -325,7 +325,7 @@ adjustment of the container in monocle would be lost when it came back (the comm
|
||||
Because KWin has a maximize of its own, and komorebi asks for it. The window gets the work area of
|
||||
its output with the panels left alone, and a restore goes back to where the window was
|
||||
(see the comment in the bridge where it carries the command out). It is the work
|
||||
area and not the padded one that [`Workspace::update`](../../komorebi/src/workspace.rs) maximizes
|
||||
area and not the padded one that [`Workspace::update`](../../../komorebi-linux/src/workspace.rs) maximizes
|
||||
a window to ("the compositor's own maximize, which is the work area and not the padded one"), so
|
||||
the window cannot be a container: a layout would give it a tile, less the padding. It is held in
|
||||
`maximized_window` instead, with the index it came from, and when it is restored it goes back to
|
||||
@@ -383,11 +383,11 @@ script that is still in KWin when its daemon is gone is a warning, since startin
|
||||
replaces it. The check tells which of the three it is by connecting to the daemon's socket and by
|
||||
asking KWin whether it has loaded `komorebi-bridge`.
|
||||
|
||||
## Why does `nix/komorebi-options.nix` start with the hash of the schema?
|
||||
## Why does `nix/linux/komorebi-options.nix` start with the hash of the schema?
|
||||
|
||||
Because the check that the options are fresh cannot make them again. `schemars-nixgen` makes
|
||||
`nix/komorebi-options.nix` from `schema.json`, and it is not in the dev shell or in CI (it is
|
||||
installed with `cargo install`). `just nixgen` writes the hash of `schema.json` as the first line
|
||||
`nix/linux/komorebi-options.nix` from `schemas/linux/schema.json`, and it is not in the dev shell or in CI (it is
|
||||
installed with `cargo install`). `just nixgen` writes the hash of `schemas/linux/schema.json` as the first line
|
||||
of the file, and the check `schema-fresh` compares that with the hash of the committed schema, and
|
||||
the schema with what `komorebic static-config-schema` prints. A change to a key that leaves the
|
||||
schema or the options behind fails the check, with no tool but the build.
|
||||
@@ -406,7 +406,7 @@ unit do not go together, since the session bus gives its name to one komorebi.
|
||||
Because 0.10.0 draws its outline in the wrong place on KWin 6.8, the oldest KWin komorebi
|
||||
supports: about 24 px too low, across the title bar. 0.11.0 is the release that handles the
|
||||
texture coordinates KWin 6.8 inverted, so
|
||||
[`nix/kde-rounded-corners.nix`](../../nix/kde-rounded-corners.nix) sets the version and the
|
||||
[`nix/linux/kde-rounded-corners.nix`](../../../nix/linux/kde-rounded-corners.nix) sets the version and the
|
||||
source of the nixpkgs package to it ([PLATFORM.md](PLATFORM.md#kwin-effects)). nixpkgs `d3b13ad`
|
||||
(2026-10-24) has 0.10.0 and `f05535a` (2026-10-27) has 0.11.0, so at time of writing
|
||||
(2026-10-28) setting them changes nothing. The package still sets them, because the patch that
|
||||
@@ -427,7 +427,7 @@ default, and its check asserts it, so that an update of the effect cannot change
|
||||
|
||||
Because the compositor has the frames, the corners and the shadows of the windows, and komorebi
|
||||
has none of them. komorebi decides what the windows look like and describes it to the backend as a
|
||||
`Look` ([`Backend::apply_look`](../../komorebi/src/backend/mod.rs)); on KWin the effect KDE
|
||||
`Look` ([`Backend::apply_look`](../../../komorebi-linux/src/backend/mod.rs)); on KWin the effect KDE
|
||||
Rounded Corners draws it, and komorebi writes the effect's settings. The same code that decides the
|
||||
look then runs against the fake desktop, which records the look it was asked for.
|
||||
|
||||
@@ -470,7 +470,7 @@ build every kind falls back to the two colors of the look, and komorebi says so
|
||||
Because the compositor draws the windows: an animation komorebi made would be a series of frames
|
||||
asked of KWin, each a command, where the Geometry Change effect animates what is painted, in the
|
||||
compositor, at the refresh rate of the screen. komorebi tells the effect how long an animation
|
||||
lasts ([`border_manager::current_look`](../../komorebi/src/border_manager/mod.rs)). That is why
|
||||
lasts ([`border_manager::current_look`](../../../komorebi-linux/src/border_manager/mod.rs)). That is why
|
||||
`animation-fps` is accepted and does nothing, and why the frame KWin reports for a window is the
|
||||
final one from the start of the animation: the effect moves what is painted and not the window
|
||||
([PLATFORM.md](PLATFORM.md#kwin-effects)).
|
||||
@@ -485,7 +485,7 @@ resize, and what the window shows does not change.
|
||||
|
||||
Because KWin animates with `QEasingCurve`, and a style is a curve KWin has when it is Qt's name
|
||||
without the "Ease": `EaseInOutSine` is `InOutSine`
|
||||
([`QtCurve::qt_curve`](../../komorebi/src/core/animation.rs)). A custom cubic Bézier is not
|
||||
([`QtCurve::qt_curve`](../../../komorebi-linux/src/core/animation.rs)). A custom cubic Bézier is not
|
||||
one of Qt's curves, and is drawn as an ease out, the kind of curve a window moving to its place
|
||||
wants. The stock Geometry Change has one curve, an exponential ease out, so komorebi's build of
|
||||
it reads a `Curve` setting ([PLATFORM.md](PLATFORM.md#the-patches)).
|
||||
@@ -493,7 +493,7 @@ it reads a `Curve` setting ([PLATFORM.md](PLATFORM.md#the-patches)).
|
||||
## Why does the window manager keep the opacity it gave each window?
|
||||
|
||||
So that the backend is told only what changed. `transparency_manager::apply`
|
||||
([`transparency_manager.rs`](../../komorebi/src/transparency_manager.rs)) is called after every
|
||||
([`transparency_manager.rs`](../../../komorebi-linux/src/transparency_manager.rs)) is called after every
|
||||
event and every message, and most of them change no window's opacity: the window manager keeps
|
||||
the opacity it gave each window that is not opaque (`WindowManager::opacity_applied`), sends the
|
||||
difference, makes a window opaque again when it should no longer be see-through (and only if it is
|
||||
@@ -683,7 +683,7 @@ already as it asked, but the user's title bar does it without komorebi's knowing
|
||||
stayed a tile would be asked to move at the next retile: the code that reads the windows that are
|
||||
open when komorebi starts says a window that is already maximized is "the maximized window, not a tile
|
||||
that would be asked to leave the maximized state". So
|
||||
[`WindowManager::adopt_maximize_change`](../../komorebi/src/window_manager.rs) takes the window out of
|
||||
[`WindowManager::adopt_maximize_change`](../../../komorebi-linux/src/window_manager.rs) takes the window out of
|
||||
the layout as `toggle-maximize` makes a window leave it, and what is asked of the layout does
|
||||
nothing "until it is restored, by `toggle-maximize` or by the user" (the comment in
|
||||
`process_command`). Because the report is the same either way, one comparison serves both: a window
|
||||
@@ -692,7 +692,7 @@ that is, or is not, already the workspace's maximized window changes nothing.
|
||||
## Why does komorebi leave a fullscreen window alone, and tile the workspace when it comes back?
|
||||
|
||||
Because the window covers the monitor on purpose. The comment in
|
||||
[`Window::set_position`](../../komorebi/src/window.rs) says that "moving it would take it out of
|
||||
[`Window::set_position`](../../../komorebi-linux/src/window.rs) says that "moving it would take it out of
|
||||
fullscreen, or be ignored", and that "it goes back to its tile when it leaves fullscreen". The
|
||||
window stays in its container, so the other windows are tiled as if it were not fullscreen, and
|
||||
every move the window manager makes goes through `set_position`, which is where the window is
|
||||
@@ -700,13 +700,13 @@ skipped. When the window comes back, "KWin gives it the frame it had before, whi
|
||||
tile it has now" (the comment in `handle_event`), so the workspace is tiled again. The bridge's
|
||||
second request for a position gives up after three tries for the same reason: so that a window that
|
||||
cannot go where it was asked, "a fullscreen one, say", is left alone rather than chased (the comment
|
||||
on `settle` in [`bridge.js`](../../komorebi/src/kwin/bridge.js)).
|
||||
on `settle` in [`bridge.js`](../../../komorebi-linux/src/kwin/bridge.js)).
|
||||
|
||||
## Why does `initial_window_placement_rules` take a number as well as text?
|
||||
|
||||
Because the documentation of the setting shows a number (`"initial_window_placement_rules": 3`),
|
||||
and a JSON object's keys can only be text: the doc comment on the `Deserialize` of
|
||||
[`PlacementTarget`](../../komorebi/src/core/mod.rs) says both. The place is read from `"Primary"`,
|
||||
[`PlacementTarget`](../../../komorebi-linux/src/core/mod.rs) says both. The place is read from `"Primary"`,
|
||||
`"3"` and `3`, so the form the page shows works as well as the form a map's keys force. In komorebi
|
||||
for Windows, at its commit 83c4e11d, the deserializer reads only text, so the number its page shows
|
||||
is refused. [The page of this repository](../initial-window-placement-rules.md#on-kde) says which
|
||||
@@ -714,8 +714,8 @@ forms are read.
|
||||
|
||||
The JSON schema of the type is written by hand, so that it says the same. The one `schemars`
|
||||
derives for the enum is an object with a `Placement` or an `Index` key, which the comment on the
|
||||
`JsonSchema` impl of [`PlacementTarget`](../../komorebi/src/core/mod.rs) calls "not what
|
||||
`Serialize` and `Deserialize` read and write". The schema `schema.json` has says a name, a number,
|
||||
`JsonSchema` impl of [`PlacementTarget`](../../../komorebi-linux/src/core/mod.rs) calls "not what
|
||||
`Serialize` and `Deserialize` read and write". The schema `schemas/linux/schema.json` has says a name, a number,
|
||||
or text that is a number, which is also what the module's typed `config` takes.
|
||||
|
||||
## Why are the key binding files read by parsers written for komorebi?
|
||||
@@ -813,7 +813,7 @@ versions.
|
||||
The repository develops against the tip of nixpkgs-unstable, a weekly workflow moves
|
||||
`flake.lock` to the tip, and a user's own nixpkgs can be newer still, so a system can have a
|
||||
KWin that no VM suite has run against. Next to the floor,
|
||||
[`nix/supported-kwin.nix`](../../nix/supported-kwin.nix) records `testedMax`, the newest KWin
|
||||
[`nix/linux/supported-kwin.nix`](../../../nix/linux/supported-kwin.nix) records `testedMax`, the newest KWin
|
||||
every suite has passed against, and the module warns above it.
|
||||
`services.komorebi.kwin.untestedIsError` turns the warning into an error. The two versions are
|
||||
written down in that one file, which the module imports and anything else can read with `nix
|
||||
|
||||
Reference in new issue
Block a user