From: Matthias Clasen Date: Sat, 5 Aug 2023 00:05:07 +0000 (-0400) Subject: build: Rename docs build options X-Git-Tag: archive/raspbian/4.12.3+ds-1+rpi1~1^2^2^2~22^2~1^2~1^2~1 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=6af55a31d757777a2d30d9f6a003ce622d8724ee;p=gtk4.git build: Rename docs build options Rename gtk_doc to documentation and update_screenshots to screenshots. The old names are still accepted. --- diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a8b4c32fee..5a3332abea 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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 diff --git a/docs/reference/gdk/meson.build b/docs/reference/gdk/meson.build index 9a38c618d6..c860eb2ca3 100644 --- a/docs/reference/gdk/meson.build +++ b/docs/reference/gdk/meson.build @@ -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', diff --git a/docs/reference/gsk/meson.build b/docs/reference/gsk/meson.build index abb30381e6..bf3c437077 100644 --- a/docs/reference/gsk/meson.build +++ b/docs/reference/gsk/meson.build @@ -1,4 +1,4 @@ -if get_option('gtk_doc') +if get_option('documentation') gsk4_toml = configure_file( input: 'gsk4.toml.in', output: 'gsk4.toml', diff --git a/docs/reference/gtk/building.md b/docs/reference/gtk/building.md index cc710976fb..5d3ac5fe7d 100644 --- a/docs/reference/gtk/building.md +++ b/docs/reference/gtk/building.md @@ -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 diff --git a/docs/reference/gtk/images/meson.build b/docs/reference/gtk/images/meson.build index 9260583bf0..fbd719192f 100644 --- a/docs/reference/gtk/images/meson.build +++ b/docs/reference/gtk/images/meson.build @@ -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), diff --git a/docs/reference/gtk/meson.build b/docs/reference/gtk/meson.build index a123971954..e5a72b100f 100644 --- a/docs/reference/gtk/meson.build +++ b/docs/reference/gtk/meson.build @@ -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', diff --git a/docs/reference/meson.build b/docs/reference/meson.build index 292e82163e..8ba66586fd 100644 --- a/docs/reference/meson.build +++ b/docs/reference/meson.build @@ -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 diff --git a/meson.build b/meson.build index 1c03a6cc48..829dfa336a 100644 --- a/meson.build +++ b/meson.build @@ -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') diff --git a/meson_options.txt b/meson_options.txt index f4399d39df..4b794e7814 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -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,