sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

docs: Move kms abstractions documentation out of references

Browse source 
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: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3505>
This commit is contained in:
Sebastian Wick 2024-01-09 17:32:47 +01:00 committed by Marge Bot
parent b5e9279ea0
commit abe47769b7
3 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/code-overview.md
View file

@ -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. 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) * [Compositor stage and hardware relationships](mutter-relationships.md)
* [KMS abstraction](mutter-kms-abstractions.md)
* [Window constraints](mutter-constraints.txt) * [Window constraints](mutter-constraints.txt)
* [How to get focus right](mutter-focus.txt) * [How to get focus right](mutter-focus.txt)

2
doc/reference/meta/kms-abstractions.md → doc/mutter-kms-abstractions.md
View file

@ -1,4 +1,4 @@
Title: KMS abstraction # KMS abstraction
The KMS abstraction consists of various building blocks for helping out with The KMS abstraction consists of various building blocks for helping out with
interacting with the various drm API's, enabling users to use a interacting with the various drm API's, enabling users to use a

1
doc/reference/meta/meta.toml.in
View file

@ -39,7 +39,6 @@ base_url = "https://gitlab.gnome.org/GNOME/mutter/-/blob/@vcs_tag@/"
[extra] [extra]
# The same order will be used when generating the index # The same order will be used when generating the index
content_files = [ content_files = [
"kms-abstractions.md",
] ]
content_images = [ content_images = [
"logo.svg", "logo.svg",