docs(comments): comments name the Linux docs and nix files where they are

Comment-only edits (no code changed): the module docs of komorebi-linux/src/kwin/mod.rs and
hotkeys.rs pointed at docs/dev/PLATFORM.md and docs/dev/DESIGN.md (now docs/linux/dev/...) and at
nix/tests/vm/suites/kwin-events (now nix/linux/...); the comment in komorebic/Cargo.toml named the
deleted shim komorebi-client-linux and now names the keys that exist (komorebi-linux, komorebi-macos).

Left alone on purpose: the same stale doc paths in comments under nix/ (not mine to edit),
fixture names (kfde-tiled), URLs, and the runtime default PathBuf::from("docs/cli") of docgen
(behaviour).

Not verified by a build: only comments changed. These files are inputs of the KDE nix derivations,
so they will rebuild.
This commit is contained in:
LGUG2Z committed 2026-11-05 15:03:27 -08:00
1 parent e0e0f49714
commit 920a3d1268
3 files changed
+7 -7

No files matched your search

+2 -2
View File
@@ -44,7 +44,7 @@
//! then [`Engine::on_tick`] abandons the chain and the keys of the mode are grabbed again. A key
//! that is not the next of the chain is not grabbed, so it reaches the focused window and the
//! chain goes on until the timeout. kglobalaccel's own key sequences are not used: they do not
//! fire on KWin 6.8 (`docs/dev/PLATFORM.md`).
//! fire on KWin 6.8 (`docs/linux/dev/PLATFORM.md`).
//!
//! # Per-application bindings
//!
@@ -78,7 +78,7 @@
//! it: the KWin backend watches `org.kde.kglobalaccel` on the session bus, and when it has an
//! owner again, [`rebind`] loads the key bindings into the new one.
//!
//! `docs/dev/PLATFORM.md` has what was measured of kglobalaccel, and the VM test `vm-keys-engine`
//! `docs/linux/dev/PLATFORM.md` has what was measured of kglobalaccel, and the VM test `vm-keys-engine`
//! presses keys in a Plasma session with the daemon running.
use crate::HOME_DIR;
+3 -3
View File
@@ -78,8 +78,8 @@
//! ([`Backend::set_wallpaper`]), without holding up the window manager, and tries again for a
//! while when the shell is not there yet.
//!
//! `docs/dev/PLATFORM.md` has the D-Bus names, the files and the environment variables involved,
//! and `docs/dev/DESIGN.md` the reasons for this design.
//! `docs/linux/dev/PLATFORM.md` has the D-Bus names, the files and the environment variables involved,
//! and `docs/linux/dev/DESIGN.md` the reasons for this design.
#![deny(missing_docs)]
@@ -353,7 +353,7 @@ pub struct KWinBackend {
/// # Example
///
/// This is how the daemon installs the backend. The VM test `vm-kwin-events`
/// (`nix/tests/vm/suites/kwin-events`) starts the daemon against a real KWin; the example needs
/// (`nix/linux/tests/vm/suites/kwin-events`) starts the daemon against a real KWin; the example needs
/// one, so it is only compiled here.
///
/// ```rust,no_run
+2 -2
View File
@@ -8,8 +8,8 @@ edition = "2024"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
# The dependencies of each platform are in its own table, so that a build for one target compiles
# nothing of the others. A dependency key can only have one path, so the Linux and macOS crates
# are renamed (`komorebi-client-linux`, ...) and main.rs gives them the names the modules use.
# nothing of the others. A dependency key can only have one path, so each daemon library has a key of
# its own (`komorebi-linux`, `komorebi-macos`) and main.rs gives them the name the modules use.
[dependencies]
komorebi-client = { path = "../komorebi-client", default-features = false }