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

237 lines
5.8 KiB
Meson
Raw Normal View History

Meson: Add missing options and conform to naming guidelines https://bugzilla.gnome.org/show_bug.cgi?id=790837
2017-11-28 16:44:04 +01:00
if get_option('gtk_doc')
Build gdbus-objectmanager-example docs unconditionally The GIO reference documentation links to that documentation, so we cannot only build it when the installed tests are enabled.
2020-10-30 17:42:53 +01:00
subdir('gdbus-object-manager-example')
meson: Build all docs
2016-12-07 11:28:33 +01:00
subdir('xml')
ignore_headers = [
'gdbus-2.0',
'inotify',
'kqueue',
'libasyncns',
'tests',
'win32',
'xdgmime',
'gappinfoprivate.h',
'gapplicationimpl.h',
'gasynchelper.h',
'gcontenttypeprivate.h',
'gcontextspecificgroup.h',
'gcredentialsprivate.h',
'gdbus-daemon-generated.h',
'gdbusactiongroup-private.h',
'gdbusauth.h',
'gdbusauthmechanismanon.h',
'gdbusauthmechanismexternal.h',
'gdbusauthmechanism.h',
'gdbusauthmechanismsha1.h',
'gdbusdaemon.h',
'gdbusprivate.h',
'gdelayedsettingsbackend.h',
docs: Ignore some private/uninstalled header files Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-11-23 14:24:24 +01:00
'gdocumentportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gdummyfile.h',
'gdummyproxyresolver.h',
'gdummytlsbackend.h',
'gfileattribute-priv.h',
'gfileinfo-priv.h',
'ghttpproxy.h',
'giomodule-priv.h',
'gioprivate.h',
gio: add fallback afunix.h header afunix.h is only recently distributed with Windows SDK & MinGW. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
2022-01-18 20:59:47 +01:00
'giowin32-afunix.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'giowin32-priv.h',
docs: Ignore some private/uninstalled header files Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-11-23 14:24:24 +01:00
'gio_probes.h',
'gio_trace.h',
'gio-tool.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'glocaldirectorymonitor.h',
'glocalfileenumerator.h',
'glocalfile.h',
'glocalfileinfo.h',
'glocalfileinputstream.h',
'glocalfileiostream.h',
'glocalfilemonitor.h',
'glocalfileoutputstream.h',
'glocalvfs.h',
gio: Add GMemoryMonitor to monitor for low-memory Add a memory monitor object, with D-Bus and Portal based implementations. The D-Bus implementation uses the Linux-only low-memory-monitor Freedesktop project. Low Memory Monitor D-Bus API: https://hadess.pages.freedesktop.org/low-memory-monitor/ Android API: https://developer.android.com/reference/android/content/ComponentCallbacks2.html#onTrimMemory(int) iOS API: https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle/responding_to_memory_warnings Win32 API: https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.systemevents.lowmemory?view=netframework-4.8 Tizen API: https://samsung.github.io/TizenFX/master/api/Tizen.Applications.EventManager.SystemEvents.LowMemory.html
2019-07-25 15:52:09 +02:00
'gmemorymonitordbus.h',
'gmemorymonitorportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gmountprivate.h',
'gnativevolumemonitor.h',
'gnetworkingprivate.h',
'gnetworkmonitorbase.h',
'gnetworkmonitornetlink.h',
'gnetworkmonitornm.h',
Meson: Fix build of gtkdoc This requires change added in Meson 0.44.0 https://bugzilla.gnome.org/show_bug.cgi?id=786796
2017-11-10 02:35:45 +01:00
'gnetworkmonitorportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gnotificationbackend.h',
'gnotification-private.h',
docs: Ignore some private/uninstalled header files Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-11-23 14:24:24 +01:00
'gopenuriportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gpollfilemonitor.h',
docs: Ignore some private/uninstalled header files Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-11-23 14:24:24 +01:00
'gportalsupport.h',
Add GPowerProfileMonitor
2021-07-20 23:04:31 +02:00
'gpowerprofilemonitordbus.h',
gio: Add portal version of GPowerProfileMonitor
2021-08-09 23:19:17 +02:00
'gpowerprofilemonitorportal.h',
Meson: Fix build of gtkdoc This requires change added in Meson 0.44.0 https://bugzilla.gnome.org/show_bug.cgi?id=786796
2017-11-10 02:35:45 +01:00
'gproxyresolverportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gregistrysettingsbackend.h',
'gresourcefile.h',
'gsettingsbackendinternal.h',
'gsettings-mapping.h',
'gsettingsschema-internal.h',
'gsocketinputstream.h',
'gsocketoutputstream.h',
'gsocks4aproxy.h',
'gsocks4proxy.h',
'gsocks5proxy.h',
'gsubprocesslauncher-private.h',
'gthreadedresolver.h',
Support the trash portal When we are in a sandbox, try to trash files via a portal. It works.
2018-08-23 06:24:42 +02:00
'gtrashportal.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gunionvolumemonitor.h',
'gunixmount.h',
'gunixresolver.h',
'gunixvolume.h',
'gunixvolumemonitor.h',
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
'gwin32networkmonitor.h',
docs: Ignore new win32 private headers Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2020-12-11 14:05:14 +01:00
'gwin32api-application-activation-manager.h',
'gwin32api-iterator.h',
'gwin32api-misc.h',
'gwin32api-package.h',
'gwin32api-storage.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gwin32appinfo.h',
docs: Ignore new win32 private headers Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2020-12-11 14:05:14 +01:00
'gwin32file-sync-stream.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gwin32mount.h',
docs: Ignore new win32 private headers Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2020-12-11 14:05:14 +01:00
'gwin32packageparser.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
'gwin32resolver.h',
'gwin32volumemonitor.h',
'thumbnail-verify.h',
'xdp-dbus.h',
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
'gio-visibility.h',
meson: Build all docs
2016-12-07 11:28:33 +01:00
]
docs: Add version and deprecation decorators to gtk-doc ignore list This allows gtk-doc to recognise a whole lot more API than it could before. Maintaining the lists between 6 build files is going to be a bit of a pain, but they only need to be modified once a cycle. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://bugzilla.gnome.org/show_bug.cgi?id=789087 https://bugzilla.gnome.org/show_bug.cgi?id=790015
2017-11-07 14:33:40 +01:00
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
sections_files = files('gio-sections-common.txt')
Platform-dependent header ignore list for gio docs This is a bit awkward. A more elegant solution would have ignored *all* headers and then *un-ignored* some of them if some conditions were met. Sadly, we cannot really ignore all headers and then "unignore" them: that's not how arrays in Meson work. https://bugzilla.gnome.org/show_bug.cgi?id=794557
2018-03-21 11:04:21 +01:00
if host_system == 'windows'
ignore_headers += [
'gfiledescriptorbased.h',
'gunixmounts.h',
'gunixfdlist.h',
'gunixfdmessage.h',
'gunixinputstream.h',
'gunixoutputstream.h',
'gdesktopappinfo.h',
'gosxappinfo.h',
]
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
sections_files += files('gio-sections-win32.txt')
platform_file = files('gio-docs-win32.xml')
Platform-dependent header ignore list for gio docs This is a bit awkward. A more elegant solution would have ignored *all* headers and then *un-ignored* some of them if some conditions were met. Sadly, we cannot really ignore all headers and then "unignore" them: that's not how arrays in Meson work. https://bugzilla.gnome.org/show_bug.cgi?id=794557
2018-03-21 11:04:21 +01:00
else
if glib_have_cocoa
ignore_headers += ['gdesktopappinfo.h']
else
ignore_headers += ['gosxappinfo.h']
endif
ignore_headers += [
'gwin32inputstream.h',
'gwin32outputstream.h',
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
'gwin32registrykey.h',
Platform-dependent header ignore list for gio docs This is a bit awkward. A more elegant solution would have ignored *all* headers and then *un-ignored* some of them if some conditions were met. Sadly, we cannot really ignore all headers and then "unignore" them: that's not how arrays in Meson work. https://bugzilla.gnome.org/show_bug.cgi?id=794557
2018-03-21 11:04:21 +01:00
]
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
platform_file = files('gio-docs-unix.xml')
Platform-dependent header ignore list for gio docs This is a bit awkward. A more elegant solution would have ignored *all* headers and then *un-ignored* some of them if some conditions were met. Sadly, we cannot really ignore all headers and then "unignore" them: that's not how arrays in Meson work. https://bugzilla.gnome.org/show_bug.cgi?id=794557
2018-03-21 11:04:21 +01:00
endif
docs: Ignore some generated source files dep-list.c isn’t generated, but contains non-documentation gtk-doc-style comments which are probably better left in place, since the code is partially external to GLib. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-07 18:23:34 +01:00
ignore_sources = [
'kqueue',
'tests',
'gdbus-daemon-generated.c',
'xdp-dbus.c',
]
meson: Build all docs
2016-12-07 11:28:33 +01:00
docpath = join_paths(glib_datadir, 'gtk-doc', 'html')
version_conf = configuration_data()
version_conf.set('VERSION', meson.project_version())
configure_file(
input: 'version.xml.in',
output: 'version.xml',
configuration: version_conf
)
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
concat_files_helper = find_program('concat-files-helper.py')
configure_file(
output : 'gio-sections.txt',
build: Specify all inputs to concat-files-helper.py Since Meson 0.52, a list of inputs is correctly supported, so our workaround can be removed. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-05-12 12:17:51 +02:00
input : sections_files,
command : [concat_files_helper, '@OUTPUT@', '@INPUT@'],
doc: Split API reference per platform We can only include win32 APIs when building for Windows because gtkdoc needs to compile the GObject classes for introspection.
2019-07-09 19:25:49 +02:00
)
configure_file(
output : 'gio-docs-platform.xml',
input : platform_file,
copy : true,
)
docs: Fix configuration with gtk_doc=true and installed_tests=false Skip the gdbus-object-manager-example which is generated as part of testing. Program xsltproc found: YES (/usr/bin/xsltproc) Run-time dependency gtk-doc found: YES 1.32 docs/reference/gio/gdbus-object-manager-example/meson.build:1:0: ERROR: Unknown variable "libgdbus_example_objectmanager_dep".
2020-03-27 20:33:12 +01:00
content_files = [
'overview.xml',
'migrating-posix.xml',
'migrating-gnome-vfs.xml',
'migrating-gconf.xml',
'migrating-gdbus.xml',
'gio-querymodules.xml',
'glib-compile-schemas.xml',
'glib-compile-resources.xml',
'gapplication.xml',
'gsettings.xml',
'gresource.xml',
'gdbus.xml',
'gdbus-codegen.xml',
]
Build gdbus-objectmanager-example docs unconditionally The GIO reference documentation links to that documentation, so we cannot only build it when the installed tests are enabled.
2020-10-30 17:42:53 +01:00
content_files += [
gdbus_example_objectmanager_xml,
gdbus_example_objectmanager_sources,
gdbus_object_manager_example_doc
]
docs: Fix configuration with gtk_doc=true and installed_tests=false Skip the gdbus-object-manager-example which is generated as part of testing. Program xsltproc found: YES (/usr/bin/xsltproc) Run-time dependency gtk-doc found: YES 1.32 docs/reference/gio/gdbus-object-manager-example/meson.build:1:0: ERROR: Unknown variable "libgdbus_example_objectmanager_dep".
2020-03-27 20:33:12 +01:00
meson: Build all docs
2016-12-07 11:28:33 +01:00
gnome.gtkdoc('gio',
main_xml : 'gio-docs.xml',
namespace : 'g',
mode : 'none',
dependencies : [libgio_dep, libgobject_dep, libglib_dep],
meson: Match upstream gtkdoc changes
2016-12-09 19:51:41 +01:00
src_dir : 'gio',
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
scan_args : [
'--ignore-decorators=' + ignore_decorators.replace('GLIB', 'GIO'),
meson: Build all docs
2016-12-07 11:28:33 +01:00
'--rebuild-types',
'--ignore-headers=' + ' '.join(ignore_headers),
],
docs: Ignore some generated source files dep-list.c isn’t generated, but contains non-documentation gtk-doc-style comments which are probably better left in place, since the code is partially external to GLib. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-03-07 18:23:34 +01:00
mkdb_args : [
'--ignore-files=' + ' '.join(ignore_sources),
],
docs: Fix configuration with gtk_doc=true and installed_tests=false Skip the gdbus-object-manager-example which is generated as part of testing. Program xsltproc found: YES (/usr/bin/xsltproc) Run-time dependency gtk-doc found: YES 1.32 docs/reference/gio/gdbus-object-manager-example/meson.build:1:0: ERROR: Unknown variable "libgdbus_example_objectmanager_dep".
2020-03-27 20:33:12 +01:00
content_files : content_files,
meson: Build all docs
2016-12-07 11:28:33 +01:00
expand_content_files : [
'overview.xml',
'migrating-posix.xml',
'migrating-gnome-vfs.xml',
'migrating-gconf.xml',
'migrating-gdbus.xml',
'gdbus-codegen.xml',
],
html_assets : [
'gvfs-overview.png',
'menu-example.png',
'menu-model.png',
],
fixxref_args: [
'--html-dir=' + docpath,
Meson: doc: fix cross references
2018-09-23 22:01:48 +02:00
'--extra-dir=' + join_paths('gio', '..', 'glib', 'html'),
'--extra-dir=' + join_paths('gio', '..', 'gobject', 'html'),
meson: Build all docs
2016-12-07 11:28:33 +01:00
],
doc: Run gtkdoc-check with unit tests This has the side effect of always rebuilding the doc at each build when gtk_doc option is enabled (not by default). Most importantly, this will enable doc check on our CI.
2019-07-09 21:51:32 +02:00
install: true,
check: true,
meson: Build all docs
2016-12-07 11:28:33 +01:00
)
endif
Meson: Add missing options and conform to naming guidelines https://bugzilla.gnome.org/show_bug.cgi?id=790837
2017-11-28 16:44:04 +01:00
if get_option('man')
meson: Detect with-docs and with-man automatically By default, only build man pages and gtk-doc if the build-deps were found. To force-enable, pass -Dwith-docs=yes and -Dwith-man=yes. Also use a foreach loop for man pages instead of listing them all manually
2017-03-21 12:08:47 +01:00
manpages = ['gapplication', 'gio-querymodules', 'glib-compile-schemas',
'glib-compile-resources', 'gsettings', 'gresource', 'gdbus',
'gio', 'gdbus-codegen']
foreach page : manpages
custom_target(page + '-man',
input: page + '.xml',
output: page + '.1',
command: xsltproc_command,
install: true,
install_dir: man1_dir)
endforeach
meson: Build all docs
2016-12-07 11:28:33 +01:00
endif
Reference in New Issue Copy Permalink