From 90956b15d9fb74e635eb141e190dac6fcc526172 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 16 Mar 2024 20:37:04 -0400 Subject: [PATCH] docs: Small tweaks --- docs/reference/gtk/building.md | 31 +++++++++++++++--------------- docs/reference/gtk/css-overview.md | 2 +- docs/reference/gtk/overview.md | 4 ++++ docs/reference/gtk/running.md | 8 ++++---- 4 files changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/reference/gtk/building.md b/docs/reference/gtk/building.md index cff61d3d9e..e00bdb2919 100644 --- a/docs/reference/gtk/building.md +++ b/docs/reference/gtk/building.md @@ -38,13 +38,13 @@ can run the build, using Ninja: ``` cd builddir -ninja -ninja install +meson compile +meson install ``` If you don't have permission to write to the directory you are installing in, you may have to change to root temporarily before -running `ninja install`. +running `meson install`. Several environment variables are useful to pass to set before running *meson*. `CPPFLAGS` contains options to pass to the C @@ -112,10 +112,10 @@ responsible for controlling the debugging features of GTK with ## Dependencies -Before you can compile the GTK widget toolkit, you need to have -various other tools and libraries installed on your -system. Dependencies of GTK have their own build systems, so -you will need to refer to their own installation instructions. +Before you can compile GTK, you need to have various other tools and +libraries installed on your system. Dependencies of GTK have their own +build systems, so you will need to refer to their own installation +instructions. A particular important tool used by GTK to find its dependencies is `pkg-config`. @@ -156,8 +156,8 @@ Other libraries are maintained separately. the development environment for these libraries that your operating system vendor provides. - The [fontconfig](https://www.freedesktop.org/wiki/Software/fontconfig/) - library provides Pango with a standard way of locating - fonts and matching them against font names. + library provides Pango with a standard way of locating fonts and matching + them against font names. - [Cairo](https://www.cairographics.org) is a graphics library that supports vector graphics and image compositing. Both Pango and GTK use Cairo for drawing. Note that we also need the auxiliary cairo-gobject @@ -220,13 +220,12 @@ meson configure builddir ### `x11-backend`, `win32-backend`, `broadway-backend`, `wayland-backend` and `macos-backend` -Enable specific backends for GDK. If none of these options -are given, the Wayland backend will be enabled by default, -if the platform is Linux; the X11 backend will also be enabled -by default, unless the platform is Windows, in which case the -default is win32, or the platform is macOS, in which case the -default is macOS. If any backend is explicitly enabled or disabled, -no other platform will be enabled automatically. +Enable specific backends for GDK. If none of these options are given, the +Wayland backend will be enabled by default, if the platform is Linux; the +X11 backend will also be enabled by default, unless the platform is Windows, +in which case the default is win32, or the platform is macOS, in which case +the default is macOS. If any backend is explicitly enabled or disabled, no +other platform will be enabled automatically. ### `vulkan` diff --git a/docs/reference/gtk/css-overview.md b/docs/reference/gtk/css-overview.md index 197f64cf34..dcc6c5811f 100644 --- a/docs/reference/gtk/css-overview.md +++ b/docs/reference/gtk/css-overview.md @@ -1,7 +1,7 @@ Title: CSS in GTK Slug: css -This chapter describes how GTK uses CSS for styling and layout. +This chapter describes how GTK uses CSS for styling and layout. It is not meant to be an explanation of CSS from first principles, but focuses on listing supported CSS features and differences between Web CSS and GTK. diff --git a/docs/reference/gtk/overview.md b/docs/reference/gtk/overview.md index 6016861e80..21073e9b01 100644 --- a/docs/reference/gtk/overview.md +++ b/docs/reference/gtk/overview.md @@ -28,6 +28,9 @@ GTK depends on the following libraries: - **OpenGL**: OpenGL is the premier environment for developing portable, interactive 2D and 3D graphics applications. More information available on the [Khronos website][opengl]. + - **Vulkan**: Vulkan is the a newer graphics API, that can be considered + the successor of OpenGL. More information available on the + [Khronos website][vulkan]. - **Pango**: Pango is a library for internationalized text handling. It centers around the `PangoLayout` object, representing a paragraph of text. Pango provides the engine for `GtkTextView`, `GtkLabel`, @@ -60,6 +63,7 @@ GTK is divided into three parts: [gio]: https://developer.gnome.org/gio/stable/ [cairo]: https://www.cairographics.org/manual/ [opengl]: https://www.opengl.org/about/ +[vulkan]: https://www.vulkan.org/ [pango]: https://pango.gnome.org/ [gdkpixbuf]: https://developer.gnome.org/gdk-pixbuf/stable/ [graphene]: https://ebassi.github.io/graphene/ diff --git a/docs/reference/gtk/running.md b/docs/reference/gtk/running.md index f0193a3447..879e23d2e9 100644 --- a/docs/reference/gtk/running.md +++ b/docs/reference/gtk/running.md @@ -482,10 +482,10 @@ n seconds. The default timeout is 15 seconds. ### `GSK_MAX_TEXTURE_SIZE` -Limit texture size to the minimum of this value and the OpenGL limit -for texture sizes. This can be used to debug issues with texture slicing -on systems where the OpenGL texture size limit would otherwise make -texture slicing difficult to test. +Limit texture size to the minimum of this value and the OpenGL limit for +texture sizes in the "gl" renderer. This can be used to debug issues with +texture slicing on systems where the OpenGL texture size limit would +otherwise make texture slicing difficult to test. ### `GTK_CSD`