build: Rename docs build options

Rename gtk_doc to documentation and update_screenshots
to screenshots. The old names are still accepted.
This commit is contained in:
Matthias Clasen
2023-08-04 20:05:07 -04:00
parent 0b6b6b0984
commit 6af55a31d7
9 changed files with 46 additions and 31 deletions

View File

@@ -418,10 +418,11 @@ reference:
--buildtype=release --buildtype=release
--force-fallback-for=gdk-pixbuf,pango --force-fallback-for=gdk-pixbuf,pango
-Dintrospection=enabled -Dintrospection=enabled
-Ddocumentation=true
-Dgtk_doc=true -Dgtk_doc=true
-Dgdk-pixbuf:gtk_doc=true -Dgdk-pixbuf:gtk_doc=true
-Dpango:gtk_doc=true -Dpango:gtk_doc=true
-Ddemos=false -Dbuild-demos=false
-Dbuild-examples=false -Dbuild-examples=false
-Dbuild-tests=false -Dbuild-tests=false
-Dbuild-testsuite=false -Dbuild-testsuite=false

View File

@@ -1,7 +1,7 @@
expand_content_md_files = [ expand_content_md_files = [
] ]
if get_option('gtk_doc') if get_option('documentation')
gdk4_toml = configure_file( gdk4_toml = configure_file(
input: 'gdk4.toml.in', input: 'gdk4.toml.in',
output: 'gdk4.toml', output: 'gdk4.toml',

View File

@@ -1,4 +1,4 @@
if get_option('gtk_doc') if get_option('documentation')
gsk4_toml = configure_file( gsk4_toml = configure_file(
input: 'gsk4.toml.in', input: 'gsk4.toml.in',
output: 'gsk4.toml', output: 'gsk4.toml',

View File

@@ -268,7 +268,7 @@ support in the file chooser.
This option controls whether GTK should use colord for color This option controls whether GTK should use colord for color
calibration support in the cups print backend. 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 The *gi-docgen* package is used to generate the reference documentation
included with GTK. By default support for *gi-docgen* is disabled included with GTK. By default support for *gi-docgen* is disabled

View File

@@ -78,7 +78,7 @@ ui_files = [
gtk_builder_tool = find_program('gtk4-builder-tool') gtk_builder_tool = find_program('gtk4-builder-tool')
if get_option('update_screenshots') if get_option('screenshots')
foreach ui_file: ui_files foreach ui_file: ui_files
png_file = ui_file.replace('.ui', '.png') png_file = ui_file.replace('.ui', '.png')
gtk_images += custom_target('@0@ from @1@'.format(png_file, ui_file), gtk_images += custom_target('@0@ from @1@'.format(png_file, ui_file),

View File

@@ -32,7 +32,7 @@ gtk_images = []
subdir('images') subdir('images')
if get_option('gtk_doc') if get_option('documentation')
gtk4_toml = configure_file( gtk4_toml = configure_file(
input: 'gtk4.toml.in', input: 'gtk4.toml.in',
output: 'gtk4.toml', output: 'gtk4.toml',

View File

@@ -1,7 +1,7 @@
toml_conf = configuration_data() toml_conf = configuration_data()
toml_conf.set('version', meson.project_version()) 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 = [ gidocgen_common_args = [
'--quiet', '--quiet',
@@ -14,7 +14,7 @@ endif
docs_dir = gtk_datadir / 'doc' 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.') error('API reference requires introspection.')
endif endif

View File

@@ -742,7 +742,7 @@ if not gir.found() and get_option('introspection').enabled()
endif endif
build_gir = gir.found() and (get_option('introspection').enabled() or 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 # Resource building
glib_compile_resources = find_program('glib-compile-resources') 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('Debugging', get_option('debug'), section: 'Build')
summary('Optimization', get_option('optimization'), section: 'Build') summary('Optimization', get_option('optimization'), section: 'Build')
summary('Introspection', build_gir, 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('Man pages', get_option('man-pages'), section: 'Build')
summary('Testsuite', get_option('build-testsuite'), section: 'Build') summary('Testsuite', get_option('build-testsuite'), section: 'Build')
summary('Tests', get_option('build-tests'), section: 'Build') summary('Tests', get_option('build-tests'), section: 'Build')

View File

@@ -83,22 +83,7 @@ option('f16c',
value: 'enabled', value: 'enabled',
description: 'Enable F16C fast paths (requires F16C)') description: 'Enable F16C fast paths (requires F16C)')
# Documentation and introspection # Introspection
option('gtk_doc',
type: 'boolean',
value: false,
description : 'Build API reference and tools documentation')
option('update_screenshots',
type: 'boolean',
value: false,
description : 'Regenerate screenshots for the documentation')
option('man-pages',
type: 'boolean',
value: false,
description : 'Build man pages for installed tools')
option('introspection', option('introspection',
type: 'feature', type: 'feature',
@@ -106,6 +91,35 @@ option('introspection',
yield: true, yield: true,
description : 'Build introspection data (requires gobject-introspection)') description : 'Build introspection data (requires gobject-introspection)')
# Documentation
option('documentation',
type: 'boolean',
value: false,
description : 'Build API reference and tools documentation')
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')
# Demos, examples and tests # Demos, examples and tests
option('demo-profile', option('demo-profile',
@@ -114,17 +128,17 @@ option('demo-profile',
value: 'default', value: 'default',
description : 'Profile to use for demos') description : 'Profile to use for demos')
option('build-demos',
type: 'boolean',
value: true,
description : 'Build demo programs')
option('profile', option('profile',
type: 'combo', type: 'combo',
choices: [ 'default', 'devel' ], choices: [ 'default', 'devel' ],
value: 'default', value: 'default',
deprecated: 'demo-profile') deprecated: 'demo-profile')
option('build-demos',
type: 'boolean',
value: true,
description : 'Build demo programs')
option('demos', option('demos',
type: 'boolean', type: 'boolean',
value: true, value: true,