luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-14 13:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
1464d6ab36
glib/docs/reference/meson.build

59 lines
1.9 KiB
Meson
Raw Normal View History

build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
# The list of minor versions in the 2.x.x series which have had
# GLIB_AVAILABLE_IN_* macros. This should include the current unreleased stable
# version.
meson: Use range() instead of listing all stable versions Note that range(), like in python, has start value included and stop value excluded. That's why we use last_version + 2.
2022-05-11 20:34:00 +02:00
first_version = 26
last_version = minor_version.is_odd() ? minor_version + 1 : minor_version
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
ignore_decorators = [
'GLIB_VAR',
'G_GNUC_INTERNAL',
'G_GNUC_WARN_UNUSED_RESULT',
'GLIB_AVAILABLE_IN_ALL',
]
meson: Use range() instead of listing all stable versions Note that range(), like in python, has start value included and stop value excluded. That's why we use last_version + 2.
2022-05-11 20:34:00 +02:00
foreach i : range(first_version, last_version + 2, 2)
version = i.to_string()
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
ignore_decorators += [
doc: Add missing --ignore-decorators (cherry picked from commit 6ea0dcc6c9af0c0e8cfebc77412838f5174b7dbc)
2019-07-09 14:26:38 +02:00
# Note that gtkdoc is going to use those in regex, and the longest match
# must come first. That's why '_FOR()' variant comes first.
# gtkdoc special-case '()' and replace it by a regex matching a symbol name.
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
'GLIB_AVAILABLE_IN_2_' + version,
doc: Add missing --ignore-decorators (cherry picked from commit 6ea0dcc6c9af0c0e8cfebc77412838f5174b7dbc)
2019-07-09 14:26:38 +02:00
'GLIB_DEPRECATED_IN_2_' + version + '_FOR()',
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
'GLIB_DEPRECATED_IN_2_' + version,
doc: Add missing --ignore-decorators (cherry picked from commit 6ea0dcc6c9af0c0e8cfebc77412838f5174b7dbc)
2019-07-09 14:26:38 +02:00
Revert "Revert "glib: annotate static inline functions with G_AVAILABLE-type macros"" This reverts commit c0146be3a4e0cda7a23d7fd54cc60a0bc7ba7f7a. The revert was originally added because the original change broke gnome-build-meta. Now that the problem has been diagnosed, the original commit can be fixed — see the commit which follows this one. See: !1487
2020-05-15 12:45:33 +02:00
'GLIB_AVAILABLE_STATIC_INLINE_IN_2_' + version,
doc: Add missing --ignore-decorators (cherry picked from commit 6ea0dcc6c9af0c0e8cfebc77412838f5174b7dbc)
2019-07-09 14:26:38 +02:00
'GLIB_AVAILABLE_ENUMERATOR_IN_2_' + version,
'GLIB_DEPRECATED_ENUMERATOR_IN_2_' + version + '_FOR()',
'GLIB_DEPRECATED_ENUMERATOR_IN_2_' + version,
'GLIB_AVAILABLE_MACRO_IN_2_' + version,
'GLIB_DEPRECATED_MACRO_IN_2_' + version + '_FOR()',
'GLIB_DEPRECATED_MACRO_IN_2_' + version,
'GLIB_AVAILABLE_TYPE_IN_2_' + version,
'GLIB_DEPRECATED_TYPE_IN_2_' + version + '_FOR()',
'GLIB_DEPRECATED_TYPE_IN_2_' + version,
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
]
endforeach
Fix symbol visibility macros on Windows There is currently no `dllimport` attribute on any of our function, which prevents MSVC to optimize function calls. To fix that issue, we need to redeclare all our visibility macros for each of our libraries, because when compiling e.g. GIO code, we need dllimport in GLIB headers and dllexport in GIO headers. That means they cannot use the same GLIB_AVAILABLE_* macro. Since that's a lot of boilerplate to copy/paste after each version bump, this MR generate all those macros using a python script. Also simplify the meson side by using `gnu_symbol_visibility : 'hidden'` keyword argument instead of passing the cflag manually. This leaves only API index to add manually into glib-docs.xml when bumping GLib version. That file cannot be generated because Meson does not allow passing a buit file to gnome.gtkdoc()'s main_xml kwarg unfortunately.
2022-10-03 16:36:04 +02:00
ignore_decorators = '|'.join(ignore_decorators)
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
gtk-doc: Ensure we have recent enough version Older versions won't produce errors, but will silently miss documentation for a few symbols.
2019-11-29 20:29:23 +01:00
if get_option('gtk_doc')
# Check we have the minimum gtk-doc version required. Older versions won't
# generate correct documentation.
docs: Bump gtk-doc requirement for unit tests to 1.32.1 gtk-doc 1.33 hasn’t been released yet, but when it is, it’ll contain three fixes which are necessary for correctly detecting which symbols are undocumented/undeclared/unused in GLib: • gtk-doc@b866a90b • gtk-doc@ca42972c • gtk-doc@b922e148 1.32.1 is the development version number which will eventually be released as 1.33. Until then, we can’t run the gtk-doc tests in CI because they reliably fail spuriously. See !1488. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-05-22 10:32:52 +02:00
dependency('gtk-doc', version : '>=1.32.1',
doc: Add gtk-doc subproject fallback Now that we require Meson 0.52 to build the doc, we can also pull gtk-doc as subproject when missing from the system. This requires to pull gtk-doc master because needed changes there haven't been release yet.
2019-12-13 19:46:00 +01:00
fallback : ['gtk-doc', 'dummy_dep'],
default_options : ['tests=false'])
gtk-doc: Ensure we have recent enough version Older versions won't produce errors, but will silently miss documentation for a few symbols.
2019-11-29 20:29:23 +01:00
endif
Build API docs only with shared libraries Building the references requires libraries with all their symbols available. Passing `-Dgtk_doc=true` and `-Ddefault_library=static` should be considered a configuration error.
2022-09-14 16:03:43 +02:00
# We cannot built the API reference off of a static library,
# as symbols might get dropped by the linker
if get_option('gtk_doc') and get_option('default_library') == 'static'
error('The API reference can only be built against a shared library')
endif
build: Factor out common gtkdoc flags Those lists were getting very long. We can’t quite entirely automate the list generation since Meson doesn’t have a range() function, but we can at least combine three of them into one. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-06 12:59:03 +01:00
subdir('gio')
subdir('glib')
Revert "Revert "glib: annotate static inline functions with G_AVAILABLE-type macros"" This reverts commit c0146be3a4e0cda7a23d7fd54cc60a0bc7ba7f7a. The revert was originally added because the original change broke gnome-build-meta. Now that the problem has been diagnosed, the original commit can be fixed — see the commit which follows this one. See: !1487
2020-05-15 12:45:33 +02:00
subdir('gobject')
Reference in New Issue Copy Permalink