From abe47769b7d6b6e1ce99d48a14a2218361dad753 Mon Sep 17 00:00:00 2001 From: Sebastian Wick Date: Tue, 9 Jan 2024 17:32:47 +0100 Subject: [PATCH] docs: Move kms abstractions documentation out of references Eventually we want to have all the high-level code documentation in the component API reference documentation. However, gi-docgen is currently missing support for mermaid so we just keep the files in `doc/` and link to them from `code-overview.md`. Part-of: --- doc/code-overview.md | 1 + .../meta/kms-abstractions.md => mutter-kms-abstractions.md} | 2 +- doc/reference/meta/meta.toml.in | 1 - 3 files changed, 2 insertions(+), 2 deletions(-) rename doc/{reference/meta/kms-abstractions.md => mutter-kms-abstractions.md} (99%) diff --git a/doc/code-overview.md b/doc/code-overview.md index 7e61314b9..53ffb52ab 100644 --- a/doc/code-overview.md +++ b/doc/code-overview.md @@ -22,5 +22,6 @@ 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) +* [KMS abstraction](mutter-kms-abstractions.md) * [Window constraints](mutter-constraints.txt) * [How to get focus right](mutter-focus.txt) diff --git a/doc/reference/meta/kms-abstractions.md b/doc/mutter-kms-abstractions.md similarity index 99% rename from doc/reference/meta/kms-abstractions.md rename to doc/mutter-kms-abstractions.md index 2883fb080..49d83b0ea 100644 --- a/doc/reference/meta/kms-abstractions.md +++ b/doc/mutter-kms-abstractions.md @@ -1,4 +1,4 @@ -Title: KMS abstraction +# KMS abstraction The KMS abstraction consists of various building blocks for helping out with interacting with the various drm API's, enabling users to use a diff --git a/doc/reference/meta/meta.toml.in b/doc/reference/meta/meta.toml.in index d0e6d22ce..3aec9f462 100644 --- a/doc/reference/meta/meta.toml.in +++ b/doc/reference/meta/meta.toml.in @@ -39,7 +39,6 @@ base_url = "https://gitlab.gnome.org/GNOME/mutter/-/blob/@vcs_tag@/" [extra] # The same order will be used when generating the index content_files = [ - "kms-abstractions.md", ] content_images = [ "logo.svg",