From 50936e9953ac80767260ebd734b4a351d9f98e69 Mon Sep 17 00:00:00 2001 From: Sebastian Wick Date: Wed, 3 Jan 2024 22:30:16 +0100 Subject: [PATCH] docs: Prefix code documentation files with the subsystem they belong to. This makes it easier to see which files belong where. Part-of: --- doc/{frame-scheduling.md => clutter-frame-scheduling.md} | 2 +- doc/code-overview.md | 6 +++--- doc/{how-constraints-works.txt => mutter-constraints.txt} | 0 doc/{how-to-get-focus-right.txt => mutter-focus.txt} | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename doc/{frame-scheduling.md => clutter-frame-scheduling.md} (94%) rename doc/{how-constraints-works.txt => mutter-constraints.txt} (100%) rename doc/{how-to-get-focus-right.txt => mutter-focus.txt} (100%) diff --git a/doc/frame-scheduling.md b/doc/clutter-frame-scheduling.md similarity index 94% rename from doc/frame-scheduling.md rename to doc/clutter-frame-scheduling.md index 7fa550cb2..50d0985da 100644 --- a/doc/frame-scheduling.md +++ b/doc/clutter-frame-scheduling.md @@ -1,4 +1,4 @@ -# Frame scheduling +# Clutter Frame scheduling `ClutterFrameClock` state diagram. diff --git a/doc/code-overview.md b/doc/code-overview.md index 4f4b78a98..60276ded3 100644 --- a/doc/code-overview.md +++ b/doc/code-overview.md @@ -10,7 +10,7 @@ Hardware acceleration pipeline abstraction layer. Handles things like allocating Compositing toolkit, containing an actor and render node based scene graph, and has features such as input event routing, transformation and animation. Handles compositing, both Wayland surfaces, X11 windows, and is the basis of the UI toolkit implemented by [GNOME Shell](https://gitlab.gnome.org/GNOME/gnome-shell). Originally a fork of [the Clutter project](https://gitlab.gnome.org/GNOME/clutter). -* [Frame Scheduling](frame-scheduling.md) +* [Frame Scheduling](clutter-frame-scheduling.md) ## Mtk @@ -21,5 +21,5 @@ The Meta Toolkit containing utilities shared by other parts of mutter. The display server and window manager library. Contains a X11 window manager and compositing manager implementation, as well as a Wayland display server implementation. * [Compositor stage and hardware relationships](mutter-relationships.md) -* [Window constraints](how-constraints-works.txt) -* [How to get focus right](how-to-get-focus-right.txt) +* [Window constraints](mutter-constraints.txt) +* [How to get focus right](mutter-focus.txt) diff --git a/doc/how-constraints-works.txt b/doc/mutter-constraints.txt similarity index 100% rename from doc/how-constraints-works.txt rename to doc/mutter-constraints.txt diff --git a/doc/how-to-get-focus-right.txt b/doc/mutter-focus.txt similarity index 100% rename from doc/how-to-get-focus-right.txt rename to doc/mutter-focus.txt