build: Rename docs build options
authorMatthias Clasen <mclasen@redhat.com>
Sat, 5 Aug 2023 00:05:07 +0000 (20:05 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 5 Aug 2023 02:30:13 +0000 (22:30 -0400)
Rename gtk_doc to documentation and update_screenshots
to screenshots. The old names are still accepted.

.gitlab-ci.yml
docs/reference/gdk/meson.build
docs/reference/gsk/meson.build
docs/reference/gtk/building.md
docs/reference/gtk/images/meson.build
docs/reference/gtk/meson.build
docs/reference/meson.build
meson.build
meson_options.txt

index a8b4c32fee291695e19e01734e1272d3cb3be8cc..5a3332abea2ec3bfc70db8089f8333c571ec1a6a 100644 (file)
@@ -418,10 +418,11 @@ reference:
             --buildtype=release
             --force-fallback-for=gdk-pixbuf,pango
             -Dintrospection=enabled
+            -Ddocumentation=true
             -Dgtk_doc=true
             -Dgdk-pixbuf:gtk_doc=true
             -Dpango:gtk_doc=true
-            -Ddemos=false
+            -Dbuild-demos=false
             -Dbuild-examples=false
             -Dbuild-tests=false
             -Dbuild-testsuite=false
index 9a38c618d61426327e0f9a418ad643f104cdc001..c860eb2ca36a8e4b755f31658bde25f5a30b0248 100644 (file)
@@ -1,7 +1,7 @@
 expand_content_md_files = [
 ]
 
-if get_option('gtk_doc')
+if get_option('documentation')
   gdk4_toml = configure_file(
     input: 'gdk4.toml.in',
     output: 'gdk4.toml',
index abb30381e69d647acca6f18866e6c72cacdbd71e..bf3c4370777c339e018f886e2b0e4467e3613e32 100644 (file)
@@ -1,4 +1,4 @@
-if get_option('gtk_doc')
+if get_option('documentation')
   gsk4_toml = configure_file(
     input: 'gsk4.toml.in',
     output: 'gsk4.toml',
index cc710976fbc1c6a7aca7f13718b68ad00a6bfb18..5d3ac5fe7dfc72ea0a141f1ec4fcf794f55ec4e1 100644 (file)
@@ -268,7 +268,7 @@ support in the file chooser.
 This option controls whether GTK should use colord for color
 calibration support in the cups print backend.
 
-### `gtk_doc`, `man-pages` and `update_screenshots`
+### `documentation`, `man-pages` and `screenshots`
 
 The *gi-docgen* package is used to generate the reference documentation
 included with GTK. By default support for *gi-docgen* is disabled
index 9260583bf06c34e003d16af54d06c500ded3e027..fbd719192f8267ae3fc02d22cb0020183c8a79bb 100644 (file)
@@ -78,7 +78,7 @@ ui_files = [
 
 gtk_builder_tool = find_program('gtk4-builder-tool')
 
-if get_option('update_screenshots')
+if get_option('screenshots')
   foreach ui_file: ui_files
     png_file = ui_file.replace('.ui', '.png')
     gtk_images += custom_target('@0@ from @1@'.format(png_file, ui_file),
index a123971954f54c043edf7da39de34d97ba0638d7..e5a72b100fdccf50fa79d37c32184ae79ae4cfb0 100644 (file)
@@ -32,7 +32,7 @@ gtk_images = []
 
 subdir('images')
 
-if get_option('gtk_doc')
+if get_option('documentation')
   gtk4_toml = configure_file(
     input: 'gtk4.toml.in',
     output: 'gtk4.toml',
index 292e82163ee342cfeb08d1a5f8f58caef15070a6..8ba66586fda284efd0a3b59c4b70073f3dbd4fe4 100644 (file)
@@ -1,7 +1,7 @@
 toml_conf = configuration_data()
 toml_conf.set('version', meson.project_version())
 
-gidocgen = find_program('gi-docgen', required: get_option('gtk_doc'), native: true)
+gidocgen = find_program('gi-docgen', required: get_option('documentation'), native: true)
 
 gidocgen_common_args = [
   '--quiet',
@@ -14,7 +14,7 @@ endif
 
 docs_dir = gtk_datadir / 'doc'
 
-if get_option('gtk_doc') and not build_gir
+if get_option('documentation') and not build_gir
   error('API reference requires introspection.')
 endif
 
index 1c03a6cc482159f69520bb733761b63e7aaead57..829dfa336a7003e2c6b879c6106a73a2c88ac7e5 100644 (file)
@@ -742,7 +742,7 @@ if not gir.found() and get_option('introspection').enabled()
 endif
 
 build_gir = gir.found() and (get_option('introspection').enabled() or
-                             (get_option('introspection').allowed() and get_option('gtk_doc')))
+                             (get_option('introspection').allowed() and get_option('documentation')))
 
 # Resource building
 glib_compile_resources = find_program('glib-compile-resources')
@@ -920,7 +920,7 @@ summary('Linker', cc.get_linker_id(), section: 'Toolchain')
 summary('Debugging', get_option('debug'), section: 'Build')
 summary('Optimization', get_option('optimization'), section: 'Build')
 summary('Introspection', build_gir, section: 'Build')
-summary('Documentation', get_option('gtk_doc'), section: 'Build')
+summary('Documentation', get_option('documentation'), section: 'Build')
 summary('Man pages', get_option('man-pages'), section: 'Build')
 summary('Testsuite', get_option('build-testsuite'), section: 'Build')
 summary('Tests', get_option('build-tests'), section: 'Build')
index f4399d39df6fadb287e1c1c6a9abbcfb5015a9a9..4b794e781418fbeca1d0505799bd9a82c6ad63eb 100644 (file)
@@ -83,29 +83,43 @@ option('f16c',
        value: 'enabled',
        description: 'Enable F16C fast paths (requires F16C)')
 
-# Documentation and introspection
+# Introspection
 
-option('gtk_doc',
+option('introspection',
+       type: 'feature',
+       value: 'auto',
+       yield: true,
+       description : 'Build introspection data (requires gobject-introspection)')
+
+# Documentation
+
+option('documentation',
        type: 'boolean',
        value: false,
        description : 'Build API reference and tools documentation')
 
-option('update_screenshots',
+option('gtk_doc',
+       type: 'boolean',
+       value: false,
+       description : 'Build API reference and tools documentation',
+       deprecated: 'documentation')
+
+option('screenshots',
        type: 'boolean',
        value: false,
        description : 'Regenerate screenshots for the documentation')
 
+option('update_screenshots',
+       type: 'boolean',
+       value: false,
+       description : 'Regenerate screenshots for the documentation',
+       deprecated: 'screenshots')
+
 option('man-pages',
        type: 'boolean',
        value: false,
        description : 'Build man pages for installed tools')
 
-option('introspection',
-       type: 'feature',
-       value: 'auto',
-       yield: true,
-       description : 'Build introspection data (requires gobject-introspection)')
-
 # Demos, examples and tests
 
 option('demo-profile',
@@ -114,17 +128,17 @@ option('demo-profile',
        value: 'default',
        description : 'Profile to use for demos')
 
-option('build-demos',
-       type: 'boolean',
-       value: true,
-       description : 'Build demo programs')
-
 option('profile',
        type: 'combo',
        choices: [ 'default', 'devel' ],
        value: 'default',
        deprecated: 'demo-profile')
 
+option('build-demos',
+       type: 'boolean',
+       value: true,
+       description : 'Build demo programs')
+
 option('demos',
        type: 'boolean',
        value: true,