diff options
author | Hyunjee Kim <hj0426.kim@samsung.com> | 2019-12-03 10:36:55 +0900 |
---|---|---|
committer | Hyunjee Kim <hj0426.kim@samsung.com> | 2019-12-03 10:36:55 +0900 |
commit | 9d4dc80d1464c073554d6816992036babadad25a (patch) | |
tree | c38e5c8021666b0a6750b243550d50d19b920ebe /docs | |
parent | aedbffaae7e80f2e7d90374faea486abbc5e57f7 (diff) | |
download | glib-9d4dc80d1464c073554d6816992036babadad25a.tar.gz glib-9d4dc80d1464c073554d6816992036babadad25a.tar.bz2 glib-9d4dc80d1464c073554d6816992036babadad25a.zip |
Imported Upstream version 2.57.2
Diffstat (limited to 'docs')
27 files changed, 309 insertions, 419 deletions
diff --git a/docs/macros.txt b/docs/macros.txt index 8b4202987..953616382 100644 --- a/docs/macros.txt +++ b/docs/macros.txt @@ -9,10 +9,6 @@ GLib's configure options and corresponding macros none --enable-debug=yes [default for development branches] -DG_ENABLE_DEBUG -g ---enable-gc-friendly=yes - #define ENABLE_GC_FRIENDLY_DEFAULT 1 ---disable-mem-pools=yes - #define DISABLE_MEM_POOLS 1 Besides these, there are some local feature specific options, but my main focus here is to concentrate on macros that affect overall GLib behaviour @@ -22,26 +18,6 @@ and/or third party code. Notes on GLib's internal and global macros ========================================== - -ENABLE_GC_FRIENDLY_DEFAULT - Newly allocated memory that isn't directly initialized, as well - as memory being freed should be reset to 0. The point here is to - allow memory checkers and similar programs that use bohem GC alike - algorithms to produce more accurate results. - This can also be accomplished by setting the environment variable - G_DEBUG=gc-friendly. -DISABLE_MEM_POOLS - Many small chunks of memory are often allocated via collective pools - in GLib and are cached after release to speed up reallocations. - For sparse memory systems this behaviour is often inferior, so - memory pools can be disabled to avoid excessive caching and force - atomic maintenance of chunks through the g_malloc/g_free. - Code currently affected by this macro: - - GList, GSList, GNode allocations - - GMemChunks become basically non-effective - - GSignal disables all caching (potentially very slow) - - GType doesn't honour the GTypeInfo n_preallocs field anymore - - the GBSearchArray flag G_BSEARCH_ALIGN_POWER2 becomes non-functional G_DISABLE_ASSERT The g_assert() and g_assert_not_reached() become non-functional with this define. The motivation is to speed up end-user apps by diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am index e04ab6843..08093e8a0 100644 --- a/docs/reference/gio/Makefile.am +++ b/docs/reference/gio/Makefile.am @@ -8,6 +8,7 @@ DOC_MAIN_SGML_FILE=gio-docs.xml # Extra options to supply to gtkdoc-scan SCAN_OPTIONS = \ + --rebuild-types \ --deprecated-guards="G_DISABLE_DEPRECATED" \ --ignore-decorators="GLIB_VAR|G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT|GLIB_AVAILABLE_IN_ALL|GLIB_AVAILABLE_IN_2_26|GLIB_AVAILABLE_IN_2_28|GLIB_AVAILABLE_IN_2_30|GLIB_AVAILABLE_IN_2_32|GLIB_AVAILABLE_IN_2_34|GLIB_AVAILABLE_IN_2_36|GLIB_AVAILABLE_IN_2_38|GLIB_AVAILABLE_IN_2_40|GLIB_AVAILABLE_IN_2_42|GLIB_AVAILABLE_IN_2_44|GLIB_AVAILABLE_IN_2_46|GLIB_AVAILABLE_IN_2_48|GLIB_AVAILABLE_IN_2_50|GLIB_AVAILABLE_IN_2_52|GLIB_AVAILABLE_IN_2_54|GLIB_AVAILABLE_IN_2_56|GLIB_DEPRECATED_IN_2_26|GLIB_DEPRECATED_IN_2_26_FOR|GLIB_DEPRECATED_IN_2_28|GLIB_DEPRECATED_IN_2_28_FOR|GLIB_DEPRECATED_IN_2_30|GLIB_DEPRECATED_IN_2_30_FOR|GLIB_DEPRECATED_IN_2_32|GLIB_DEPRECATED_IN_2_32_FOR|GLIB_DEPRECATED_IN_2_34|GLIB_DEPRECATED_IN_2_34_FOR|GLIB_DEPRECATED_IN_2_36|GLIB_DEPRECATED_IN_2_36_FOR|GLIB_DEPRECATED_IN_2_38|GLIB_DEPRECATED_IN_2_38_FOR|GLIB_DEPRECATED_IN_2_40|GLIB_DEPRECATED_IN_2_40_FOR|GLIB_DEPRECATED_IN_2_42|GLIB_DEPRECATED_IN_2_42_FOR|GLIB_DEPRECATED_IN_2_44|GLIB_DEPRECATED_IN_2_44_FOR|GLIB_DEPRECATED_IN_2_46|GLIB_DEPRECATED_IN_2_46_FOR|GLIB_DEPRECATED_IN_2_48|GLIB_DEPRECATED_IN_2_48_FOR|GLIB_DEPRECATED_IN_2_50|GLIB_DEPRECATED_IN_2_50_FOR|GLIB_DEPRECATED_IN_2_52|GLIB_DEPRECATED_IN_2_52_FOR|GLIB_DEPRECATED_IN_2_54|GLIB_DEPRECATED_IN_2_54_FOR|GLIB_DEPRECATED_IN_2_56|GLIB_DEPRECATED_IN_2_56_FOR" @@ -20,82 +21,115 @@ HFILE_GLOB= \ CFILE_GLOB=$(top_srcdir)/gio/*.c IGNORE_HFILES = \ - fam \ - fen \ - gdbus-2.0 \ - gvdb \ - 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 \ - gdummyfile.h \ - gdummyproxyresolver.h \ - gdummytlsbackend.h \ - gfileattribute-priv.h \ - gfileinfo-priv.h \ - ghttpproxy.h \ - gio_trace.h \ - giomodule-priv.h \ - gioprivate.h \ - giowin32-priv.h \ - glocaldirectorymonitor.h \ - glocalfileenumerator.h \ - glocalfile.h \ - glocalfileinfo.h \ - glocalfileinputstream.h \ - glocalfileiostream.h \ - glocalfilemonitor.h \ - glocalfileoutputstream.h \ - glocalvfs.h \ - gmountprivate.h \ - gnativevolumemonitor.h \ - gnetworkingprivate.h \ - gnetworkmonitorbase.h \ - gnetworkmonitornetlink.h \ - gnetworkmonitornm.h \ - gnotificationbackend.h \ - gnotification-private.h \ - gpollfilemonitor.h \ - 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 \ - gunionvolumemonitor.h \ - gunixmount.h \ - gunixresolver.h \ - gunixvolume.h \ - gunixvolumemonitor.h \ - gwin32appinfo.h \ - gwin32mount.h \ - gwin32resolver.h \ - gwin32volumemonitor.h \ - thumbnail-verify.h + fam \ + fen \ + gdbus-2.0 \ + gvdb \ + 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 \ + gdummyfile.h \ + gdummyproxyresolver.h \ + gdummytlsbackend.h \ + gfileattribute-priv.h \ + gfileinfo-priv.h \ + ghttpproxy.h \ + giomodule-priv.h \ + gioprivate.h \ + giowin32-priv.h \ + glocaldirectorymonitor.h \ + glocalfileenumerator.h \ + glocalfile.h \ + glocalfileinfo.h \ + glocalfileinputstream.h \ + glocalfileiostream.h \ + glocalfilemonitor.h \ + glocalfileoutputstream.h \ + glocalvfs.h \ + gmountprivate.h \ + gnativevolumemonitor.h \ + gnetworkingprivate.h \ + gnetworkmonitorbase.h \ + gnetworkmonitornetlink.h \ + gnetworkmonitornm.h \ + gnetworkmonitorportal.h \ + gnotificationbackend.h \ + gnotification-private.h \ + gpollfilemonitor.h \ + gproxyresolverportal.h \ + 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 \ + gunionvolumemonitor.h \ + gunixmount.h \ + gunixresolver.h \ + gunixvolume.h \ + gunixvolumemonitor.h \ + gwin32appinfo.h \ + gwin32mount.h \ + gwin32registrykey.h \ + gwin32resolver.h \ + gwin32volumemonitor.h \ + thumbnail-verify.h \ + xdp-dbus.h \ + $(NULL) + +if OS_WIN32 +IGNORE_HFILES += \ + gfiledescriptorbased.h \ + gunixconnection.h \ + gunixcredentialsmessage.h \ + gunixmounts.h \ + gunixfdlist.h \ + gunixfdmessage.h \ + gunixinputstream.h \ + gunixoutputstream.h \ + gunixsocketaddress.h \ + gdesktopappinfo.h \ + gosxappinfo.h \ + $(NULL) +else + +if OS_COCOA +IGNORE_HFILES += gdesktopappinfo.h +else +IGNORE_HFILES += gosxappinfo.h +endif + +IGNORE_HFILES += \ + gwin32networkmonitor.h \ + gwin32inputstream.h \ + gwin32outputstream.h \ + $(NULL) +endif MKDB_IGNORE_FILES = \ gdbus-daemon-generated.c \ @@ -198,8 +232,6 @@ endif CLEANFILES ?= CLEANFILES += $(man_MANS) -EXTRA_DIST += $(man_MANS) - dist-hook-local: all-local gio-docs-clean: clean diff --git a/docs/reference/gio/gdbus-codegen.xml b/docs/reference/gio/gdbus-codegen.xml index b1145e5ef..e4192084d 100644 --- a/docs/reference/gio/gdbus-codegen.xml +++ b/docs/reference/gio/gdbus-codegen.xml @@ -39,6 +39,8 @@ <arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg> <arg><option>--header</option></arg> <arg><option>--body</option></arg> + <arg><option>--interface-info-header</option></arg> + <arg><option>--interface-info-body</option></arg> <arg><option>--output</option> <replaceable>OUTFILE</replaceable></arg> <group choice="plain" rep="repeat"> <arg> @@ -69,7 +71,11 @@ arguments on the command line and generates output files. It currently supports generating C source code (via <option>--body</option>) or header (via <option>--header</option>) - and Docbook XML (via <option>--generate-docbook</option>). + and Docbook XML (via <option>--generate-docbook</option>). Alternatively, + more restricted C source code and headers can be generated, which just + contain the interface information (as <type>GDBusInterfaceInfo</type> + structures) using <option>--interface-info-body</option> and + <option>--interface-info-header</option>. </para> </refsect1> @@ -90,8 +96,11 @@ </para> <para> For C code generation either <option>--body</option> that - generates source code, or <option>--header</option> that - generates headers, can be used. These options must be used along with + generates source code, <option>--header</option> that + generates headers, <option>--interface-info-body</option> that generates + interface information source code, or + <option>--interface-info-header</option> that generates interface information + headers, can be used. These options must be used along with <option>--output</option>, which is used to specify the file to output to. </para> <para> @@ -282,8 +291,10 @@ Directory to output generated source to. Equivalent to changing directory before generation. </para> <para> - This option cannot be used with neither <option>--body</option> nor - <option>--header</option>, and <option>--output</option> must be used. + This option cannot be used with <option>--body</option>, + <option>--header</option>, <option>--interface-info-body</option> or + <option>--interface-info-header</option>; and + <option>--output</option> must be used. </para> </listitem> @@ -322,11 +333,51 @@ </varlistentry> <varlistentry> + <term><option>--interface-info-header</option></term> + <listitem> + <para> + If this option is passed, it will generate the header code for the + <type>GDBusInterfaceInfo</type> structures only and will write it to + the disk by using the path and file name provided by + <option>--output</option>. + </para> + <para> + Using <option>--generate-c-code</option>, <option>--generate-docbook</option> or + <option>--output-directory</option> are not allowed to be used along with + the <option>--interface-info-header</option> and + <option>--interface-info-body</option> options, because these options + are used to generate only one file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--interface-info-body</option></term> + <listitem> + <para> + If this option is passed, it will generate the source code for the + <type>GDBusInterfaceInfo</type> structures only and will write it to + the disk by using the path and file name provided by + <option>--output</option>. + </para> + <para> + Using <option>--generate-c-code</option>, <option>--generate-docbook</option> or + <option>--output-directory</option> are not allowed to be used along with + the <option>--interface-info-header</option> and + <option>--interface-info-body</option> options, because these options + are used to generate only one file. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--output</option> <replaceable>OUTFILE</replaceable></term> <listitem> <para> - The full path where the header (<option>--header</option>) or the source code - (<option>--body</option>) will be written, using the path and filename provided by + The full path where the header (<option>--header</option>, + <option>--interface-info-header</option>) or the source code + (<option>--body</option>, <option>--interface-info-body</option>) will + be written, using the path and filename provided by <option>--output</option>. The full path could be something like <literal>$($OUTFILE).{c,h}</literal>. </para> @@ -987,7 +1038,7 @@ on_handle_hello_world (MyAppFrobber *interface, <para> Please send bug reports to either the distribution bug tracker or the upstream bug tracker at - <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=glib">https://bugzilla.gnome.org/enter_bug.cgi?product=glib</ulink>. + <ulink url="https://gitlab.gnome.org/GNOME/glib/issues/new">https://gitlab.gnome.org/GNOME/glib/issues/new</ulink>. </para> </refsect1> diff --git a/docs/reference/gio/gdbus.xml b/docs/reference/gio/gdbus.xml index efcec33fe..0e6c14db1 100644 --- a/docs/reference/gio/gdbus.xml +++ b/docs/reference/gio/gdbus.xml @@ -399,7 +399,7 @@ $ gdbus wait --session --timeout 30 org.bar.SomeName <para> Please send bug reports to either the distribution bug tracker or the upstream bug tracker at - <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=glib"/>. + <ulink url="https://gitlab.gnome.org/GNOME/glib/issues/new"/>. </para> </refsect1> diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 0a35f9541..0eb560716 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -1248,6 +1248,7 @@ g_drive_stop_finish g_drive_enumerate_identifiers g_drive_get_identifier g_drive_get_sort_key +G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE <SUBSECTION Standard> G_DRIVE G_IS_DRIVE @@ -1496,6 +1497,12 @@ g_mount_operation_get_password_save g_mount_operation_set_password_save g_mount_operation_get_choice g_mount_operation_set_choice +g_mount_operation_get_is_tcrypt_hidden_volume +g_mount_operation_set_is_tcrypt_hidden_volume +g_mount_operation_get_is_tcrypt_system_volume +g_mount_operation_set_is_tcrypt_system_volume +g_mount_operation_get_pim +g_mount_operation_set_pim g_mount_operation_reply <SUBSECTION Standard> GMountOperationClass @@ -1571,6 +1578,7 @@ g_unix_mount_point_guess_can_eject g_unix_mount_points_get g_unix_mounts_get g_unix_mount_at +g_unix_mount_for g_unix_mounts_changed_since g_unix_mount_points_changed_since g_unix_mount_monitor_get @@ -1616,6 +1624,7 @@ g_desktop_app_info_get_boolean g_desktop_app_info_has_key GDesktopAppLaunchCallback g_desktop_app_info_launch_uris_as_manager +g_desktop_app_info_launch_uris_as_manager_with_fds <SUBSECTION> g_desktop_app_info_list_actions g_desktop_app_info_get_action_name diff --git a/docs/reference/gio/gio.types b/docs/reference/gio/gio.types deleted file mode 100644 index 8ab7d918f..000000000 --- a/docs/reference/gio/gio.types +++ /dev/null @@ -1,156 +0,0 @@ -g_action_get_type -g_action_group_get_type -g_action_map_get_type -g_app_info_get_type -g_app_info_monitor_get_type -g_app_launch_context_get_type -g_application_command_line_get_type -g_application_get_type -g_async_initable_get_type -g_async_result_get_type -g_buffered_input_stream_get_type -g_buffered_output_stream_get_type -g_bytes_icon_get_type -g_cancellable_get_type -g_charset_converter_get_type -g_converter_get_type -g_converter_input_stream_get_type -g_converter_output_stream_get_type -g_credentials_get_type -g_data_input_stream_get_type -g_data_output_stream_get_type -g_dbus_action_group_get_type -g_dbus_annotation_info_get_type -g_dbus_arg_info_get_type -g_dbus_auth_observer_get_type -g_dbus_connection_get_type -g_dbus_interface_get_type -g_dbus_interface_info_get_type -g_dbus_interface_skeleton_get_type -g_dbus_menu_model_get_type -g_dbus_message_get_type -g_dbus_method_info_get_type -g_dbus_method_invocation_get_type -g_dbus_node_info_get_type -g_dbus_object_get_type -g_dbus_object_manager_client_get_type -g_dbus_object_manager_get_type -g_dbus_object_manager_server_get_type -g_dbus_object_proxy_get_type -g_dbus_object_skeleton_get_type -g_dbus_property_info_get_type -g_dbus_proxy_get_type -g_dbus_server_get_type -g_dbus_signal_info_get_type -g_desktop_app_info_get_type -g_desktop_app_info_lookup_get_type -g_drive_get_type -g_dtls_client_connection_get_type -g_dtls_connection_get_type -g_dtls_server_connection_get_type -g_emblem_get_type -g_emblemed_icon_get_type -g_file_attribute_info_list_get_type -g_file_attribute_matcher_get_type -g_file_descriptor_based_get_type -g_file_enumerator_get_type -g_file_get_type -g_file_icon_get_type -g_file_info_get_type -g_file_input_stream_get_type -g_file_io_stream_get_type -g_file_monitor_get_type -g_file_output_stream_get_type -g_filename_completer_get_type -g_filter_input_stream_get_type -g_filter_output_stream_get_type -g_icon_get_type -g_inet_address_get_type -g_inet_address_mask_get_type -g_inet_socket_address_get_type -g_initable_get_type -g_input_stream_get_type -g_io_module_get_type -g_io_stream_get_type -g_list_model_get_type -g_list_store_get_type -g_loadable_icon_get_type -g_memory_input_stream_get_type -g_memory_output_stream_get_type -g_menu_attribute_iter_get_type -g_menu_get_type -g_menu_item_get_type -g_menu_link_iter_get_type -g_menu_model_get_type -g_mount_get_type -g_mount_operation_get_type -g_network_address_get_type -g_network_monitor_get_type -g_network_service_get_type -g_notification_get_type -g_output_stream_get_type -g_permission_get_type -g_pollable_input_stream_get_type -g_pollable_output_stream_get_type -g_property_action_get_type -g_proxy_address_enumerator_get_type -g_proxy_address_get_type -g_proxy_get_type -g_proxy_resolver_get_type -g_remote_action_group_get_type -g_resolver_get_type -g_resource_get_type -g_seekable_get_type -g_settings_backend_get_type -g_settings_get_type -g_settings_schema_get_type -g_settings_schema_key_get_type -g_settings_schema_source_get_type -g_simple_action_get_type -g_simple_action_group_get_type -g_simple_async_result_get_type -g_simple_io_stream_get_type -g_simple_permission_get_type -g_simple_proxy_resolver_get_type -g_socket_address_enumerator_get_type -g_socket_address_get_type -g_socket_client_get_type -g_socket_connectable_get_type -g_socket_connection_get_type -g_socket_control_message_get_type -g_socket_get_type -g_socket_listener_get_type -g_socket_service_get_type -g_srv_target_get_type -g_subprocess_get_type -g_subprocess_launcher_get_type -g_task_get_type -g_tcp_connection_get_type -g_tcp_wrapper_connection_get_type -g_test_dbus_get_type -g_themed_icon_get_type -g_threaded_socket_service_get_type -g_tls_backend_get_type -g_tls_certificate_get_type -g_tls_client_connection_get_type -g_tls_connection_get_type -g_tls_database_get_type -g_tls_file_database_get_type -g_tls_interaction_get_type -g_tls_password_get_type -g_tls_server_connection_get_type -g_unix_connection_get_type -g_unix_credentials_message_get_type -g_unix_fd_list_get_type -g_unix_fd_message_get_type -g_unix_input_stream_get_type -g_unix_mount_entry_get_type -g_unix_mount_monitor_get_type -g_unix_mount_point_get_type -g_unix_output_stream_get_type -g_unix_socket_address_get_type -g_vfs_get_type -g_volume_get_type -g_volume_monitor_get_type -g_zlib_compressor_get_type -g_zlib_decompressor_get_type diff --git a/docs/reference/gio/gio.xml b/docs/reference/gio/gio.xml index c3fd8f5b6..f2635d0b3 100644 --- a/docs/reference/gio/gio.xml +++ b/docs/reference/gio/gio.xml @@ -455,6 +455,21 @@ <listitem><para>Show extra information.</para> </listitem> </varlistentry> + <varlistentry> + <term><option>--tcrypt-pim</option></term> + <listitem><para>The numeric PIM when unlocking a VeraCrypt volume.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--tcrypt-hidden</option></term> + <listitem><para>Mount a TCRYPT hidden volume.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--tcrypt-system</option></term> + <listitem><para>Mount a TCRYPT system volume.</para> + </listitem> + </varlistentry> </variablelist> </refsect3> </listitem> diff --git a/docs/reference/gio/meson.build b/docs/reference/gio/meson.build index 47046f250..c7ca62abb 100644 --- a/docs/reference/gio/meson.build +++ b/docs/reference/gio/meson.build @@ -182,7 +182,6 @@ if get_option('gtk_doc') gnome.gtkdoc('gio', main_xml : 'gio-docs.xml', namespace : 'g', - gobject_typesfile : 'gio.types', mode : 'none', dependencies : [libgio_dep, libgobject_dep, libglib_dep], src_dir : 'gio', diff --git a/docs/reference/gio/migrating-gnome-vfs.xml b/docs/reference/gio/migrating-gnome-vfs.xml index ba3987cad..27194aa9a 100644 --- a/docs/reference/gio/migrating-gnome-vfs.xml +++ b/docs/reference/gio/migrating-gnome-vfs.xml @@ -127,7 +127,7 @@ start_monitoring_trash (void) since we have not found a compelling use case where #GnomeVFSMIMEMonitor was used. If you think you have such a use case, please report it at - <ulink url="http://bugzilla.gnome.org">bugzilla.gnome.org</ulink>. + <ulink url="https://gitlab.gnome.org/GNOME/glib/issues/new">https://gitlab.gnome.org/GNOME/glib/issues/new</ulink>. </para> </section> </chapter> diff --git a/docs/reference/gio/xml/meson.build b/docs/reference/gio/xml/meson.build index 6d1e295b8..6aeb74514 100644 --- a/docs/reference/gio/xml/meson.build +++ b/docs/reference/gio/xml/meson.build @@ -1,6 +1,6 @@ ent_conf = configuration_data() ent_conf.set('PACKAGE', 'glib') -ent_conf.set('PACKAGE_BUGREPORT', 'https://bugzilla.gnome.org/enter_bug.cgi?product=glib') +ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/glib/issues/new') ent_conf.set('PACKAGE_NAME', 'glib') ent_conf.set('PACKAGE_STRING', 'glib') ent_conf.set('PACKAGE_TARNAME', 'glib') diff --git a/docs/reference/glib/Makefile.am b/docs/reference/glib/Makefile.am index 44536cf21..dfefa25ff 100644 --- a/docs/reference/glib/Makefile.am +++ b/docs/reference/glib/Makefile.am @@ -61,7 +61,9 @@ IGNORE_HFILES = \ gtranslit-data.h \ glib-init.h \ gconstructor.h \ - valgrind.h + valgrind.h \ + gvalgrind.h \ + $(NULL) # Images to copy into HTML directory HTML_IMAGES = \ @@ -138,8 +140,6 @@ endif CLEANFILES ?= CLEANFILES += $(man_MANS) -EXTRA_DIST += $(man_MANS) - dist-hook-local: all-local glib-docs-clean: clean diff --git a/docs/reference/glib/building.xml b/docs/reference/glib/building.xml index 57c3c8c7d..b131c7561 100644 --- a/docs/reference/glib/building.xml +++ b/docs/reference/glib/building.xml @@ -228,107 +228,6 @@ </formalpara> <formalpara> - <title><option>--disable-gc-friendly</option> and - <option>--enable-gc-friendly</option></title> - - <para> - By default, and with <option>--disable-gc-friendly</option> - as well, GLib does not clear the memory for certain objects before - they are freed. For example, GLib may decide to recycle GList nodes - by putting them in a free list. However, memory profiling and debugging - tools like <ulink url="http://www.valgrind.org">Valgrind</ulink> work - better if an application does not keep dangling pointers to freed - memory (even though these pointers are no longer dereferenced), or - invalid pointers inside uninitialized memory. - The <option>--enable-gc-friendly</option> option makes GLib - clear memory in these situations: - </para> - - <itemizedlist> - <listitem> - <para> - When shrinking a GArray, GLib will clear the memory no longer - available in the array: shrink an array from 10 bytes to 7, and - the last 3 bytes will be cleared. This includes removals of single - and multiple elements. - </para> - </listitem> - <listitem> - <para> - When growing a GArray, GLib will clear the new chunk of memory. - Grow an array from 7 bytes to 10 bytes, and the last 3 bytes will - be cleared. - </para> - </listitem> - <listitem> - <para> - The above applies to GPtrArray as well. - </para> - </listitem> - <listitem> - <para> - When freeing a node from a GHashTable, GLib will first clear - the node, which used to have pointers to the key and the value - stored at that node. - </para> - </listitem> - <listitem> - <para> - When destroying or removing a GTree node, GLib will clear the node, - which used to have pointers to the node's value, and the left and - right subnodes. - </para> - </listitem> - </itemizedlist> - - <para> - Since clearing the memory has a cost, - <option>--disable-gc-friendly</option> is the default. - </para> - </formalpara> - - <formalpara> - <title><option>--disable-mem-pools</option> and - <option>--enable-mem-pools</option></title> - - <para> - Many small chunks of memory are often allocated via collective pools - in GLib and are cached after release to speed up reallocations. - For sparse memory systems this behaviour is often inferior, so - memory pools can be disabled to avoid excessive caching and force - atomic maintenance of chunks through the <function>g_malloc()</function> - and <function>g_free()</function> functions. Code currently affected by - this: - <itemizedlist> - <listitem> - <para> - <structname>GMemChunk</structname>s become basically non-effective - </para> - </listitem> - <listitem> - <para> - <structname>GSignal</structname> disables all caching - (potentially very slow) - </para> - </listitem> - <listitem> - <para> - <structname>GType</structname> doesn't honour the - <structname>GTypeInfo</structname> - <structfield>n_preallocs</structfield> field anymore - </para> - </listitem> - <listitem> - <para> - the <structname>GBSearchArray</structname> flag - <literal>G_BSEARCH_ALIGN_POWER2</literal> becomes non-functional - </para> - </listitem> - </itemizedlist> - </para> - </formalpara> - - <formalpara> <title><option>--with-threads</option></title> <para> diff --git a/docs/reference/glib/glib-docs.xml b/docs/reference/glib/glib-docs.xml index a0716c172..afebbec8b 100644 --- a/docs/reference/glib/glib-docs.xml +++ b/docs/reference/glib/glib-docs.xml @@ -119,6 +119,10 @@ <xi:include href="xml/gvariant.xml"/> <xi:include href="gvariant-varargs.xml"/> <xi:include href="gvariant-text.xml"/> + <xi:include href="xml/refcount.xml"/> + <xi:include href="xml/rcbox.xml"/> + <xi:include href="xml/arcbox.xml"/> + <xi:include href="xml/refstring.xml"/> </chapter> <chapter id="deprecated"> @@ -256,6 +260,10 @@ <title>Index of new symbols in 2.56</title> <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include> </index> + <index id="api-index-2-58" role="2.58"> + <title>Index of new symbols in 2.58</title> + <xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include> + </index> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 32a7664e8..8c733e0aa 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -219,6 +219,7 @@ MAX <SUBSECTION> ABS CLAMP +G_APPROX_VALUE <SUBSECTION> G_STRUCT_MEMBER @@ -620,6 +621,7 @@ g_source_set_name_by_id g_source_get_context g_source_set_callback GSourceFunc +G_SOURCE_FUNC g_source_set_callback_indirect g_source_set_ready_time g_source_get_ready_time @@ -1231,6 +1233,7 @@ GSpawnError G_SPAWN_ERROR GSpawnFlags GSpawnChildSetupFunc +g_spawn_async_with_fds g_spawn_async_with_pipes g_spawn_async g_spawn_sync @@ -3146,6 +3149,7 @@ g_assert_cmpint g_assert_cmpuint g_assert_cmphex g_assert_cmpfloat +g_assert_cmpfloat_with_epsilon g_assert_cmpmem g_assert_no_error g_assert_error @@ -3447,3 +3451,54 @@ g_hostname_is_ip_address g_uuid_string_is_valid g_uuid_string_random </SECTION> + +<SECTION> +<FILE>refcount</FILE> +grefcount +g_ref_count_init +g_ref_count_inc +g_ref_count_dec +g_ref_count_compare +<SUBSECTION> +gatomicrefcount +g_atomic_ref_count_init +g_atomic_ref_count_inc +g_atomic_ref_count_dec +g_atomic_ref_count_compare +</SECTION> + +<SECTION> +<FILE>rcbox</FILE> +g_rc_box_alloc +g_rc_box_alloc0 +g_rc_box_new +g_rc_box_new0 +g_rc_box_dup +g_rc_box_acquire +g_rc_box_release +g_rc_box_release_full +g_rc_box_get_size +</SECTION> + +<SECTION> +<FILE>arcbox</FILE> +g_atomic_rc_box_alloc +g_atomic_rc_box_alloc0 +g_atomic_rc_box_new +g_atomic_rc_box_new0 +g_atomic_rc_box_dup +g_atomic_rc_box_acquire +g_atomic_rc_box_release +g_atomic_rc_box_release_full +g_atomic_rc_box_get_size +</SECTION> + +<SECTION> +<FILE>refstring</FILE> +g_ref_string_new +g_ref_string_new_intern +g_ref_string_new_len +g_ref_string_acquire +g_ref_string_release +g_ref_string_length +</SECTION> diff --git a/docs/reference/glib/glib.types b/docs/reference/glib/glib.types deleted file mode 100644 index e69de29bb..000000000 --- a/docs/reference/glib/glib.types +++ /dev/null diff --git a/docs/reference/glib/gvariant-text.xml b/docs/reference/glib/gvariant-text.xml index da80d174e..d569f0c74 100644 --- a/docs/reference/glib/gvariant-text.xml +++ b/docs/reference/glib/gvariant-text.xml @@ -563,7 +563,10 @@ <title>Bytestrings</title> <para> The bytestring syntax is a piece of syntactic sugar meant to complement the bytestring APIs in GVariant. It - constructs arrays of non-nul bytes (type '<literal>ay</literal>') with a nul terminator at the end. + constructs arrays of non-nul bytes (type '<literal>ay</literal>') with a nul terminator at the end. These are + normal C strings with no particular encoding enforced, so the bytes may not be valid UTF-8. + Bytestrings are a special case of byte arrays; byte arrays (also type '<literal>ay</literal>'), in the general + case, can contain nul at any position, and need not end with nul. </para> <para> Bytestrings are specified with either <literal>b""</literal> or <literal>b''</literal>. As with strings, @@ -576,7 +579,7 @@ forms <literal>\0nnn</literal> and <literal>\xnn</literal>. </para> <para> - <literal>b'abc'</literal> is equivalent to <literal>[byte 0x97, 0x98, 0x99, 0]</literal>. + <literal>b'abc'</literal> is equivalent to <literal>[byte 0x61, 0x62, 0x63, 0]</literal>. </para> <para> When formatting arrays of bytes, the printer will choose to display the array as a bytestring if it contains diff --git a/docs/reference/glib/gvariant-varargs.xml b/docs/reference/glib/gvariant-varargs.xml index fbbbfcbd3..b60ab2a34 100644 --- a/docs/reference/glib/gvariant-varargs.xml +++ b/docs/reference/glib/gvariant-varargs.xml @@ -984,7 +984,7 @@ data = g_variant_new_parsed ("(%o, {'brightness': {'value': <%i>, 'max': <%i>}}) <para> The '<literal>^</literal>' character currently supports conversion to and from bytestrings or to and from arrays - of strings or bytestrings. It has a number of forms. + of strings or bytestrings. It does not support byte arrays. It has a number of forms. </para> <para> diff --git a/docs/reference/glib/meson.build b/docs/reference/glib/meson.build index f0f915e96..fbe3422d0 100644 --- a/docs/reference/glib/meson.build +++ b/docs/reference/glib/meson.build @@ -34,6 +34,7 @@ if get_option('gtk_doc') 'glib-init.h', 'gconstructor.h', 'valgrind.h', + 'gvalgrind.h', ] ignore_decorators = [ @@ -107,7 +108,6 @@ if get_option('gtk_doc') src_dir : [ 'glib', 'gmodule' ], dependencies : libglib_dep, scan_args : [ - '--rebuild-types', '--deprecated-guards=G_DISABLE_DEPRECATED', '--ignore-decorators=' + '|'.join(ignore_decorators), '--ignore-headers=' + ' '.join(ignore_headers), diff --git a/docs/reference/glib/resources.xml b/docs/reference/glib/resources.xml index 186bbf744..80e6f4cd2 100644 --- a/docs/reference/glib/resources.xml +++ b/docs/reference/glib/resources.xml @@ -21,11 +21,10 @@ Getting help with GLib <para> If you encounter a bug, misfeature, or missing feature in GLib, please -file a bug report on -<ulink url="http://bugzilla.gnome.org">http://bugzilla.gnome.org</ulink>. +file a bug report on the issue tracker at +<ulink url="https://gitlab.gnome.org/GNOME/glib/issues/new">https://gitlab.gnome.org/GNOME/glib/issues/new</ulink>. We'd also appreciate reports of incomplete or misleading information in -the GLib documentation; file those against the "docs" component of the "glib" -product in Bugzilla. +the GLib documentation; file those with the ‘Documentation’ label. </para> <para> @@ -36,30 +35,28 @@ discussed, we'll add a note to that effect in the report. </para> <para> -The bug tracker should definitely be used for feature requests, it's -not only for bugs. We track all GLib development in Bugzilla, so it's +The issue tracker should definitely be used for feature requests, it's +not only for bugs. We track all GLib development in GitLab, so it's the way to be sure the GLib developers won't forget about an issue. </para> </refsect1> <refsect1> -<title>Submitting Patches</title> +<title>Code Contributions</title> <para> -If you develop a bugfix or enhancement for GLib, please file that in -Bugzilla as well. Bugzilla allows you to attach files; please attach a -patch generated by the <command>diff</command> utility, using the -<option>-u</option> option to make the patch more readable. All patches -must be offered under the terms of the GNU LGPL license, so be sure you -are authorized to give us the patch under those terms. +If you develop a bugfix or enhancement for GLib, please open a merge request +for that in GitLab as well. All branches must be offered under the terms of +the GNU LGPL license, so be sure you are authorized to give us the branch +under those terms. </para> <para> -If you want to discuss your patch before or after developing it, mail +If you want to discuss your branch before or after developing it, mail <ulink url="mailto:gtk-devel-list@gnome.org">gtk-devel-list@gnome.org</ulink>. -But be sure to file the Bugzilla report as well; if the patch is only on the -list and not in Bugzilla, it's likely to slip through the cracks. +But be sure to create the GitLab merge request as well; if the branch is only +on the list and not in GitLab, it's likely to slip through the cracks. </para> </refsect1> @@ -92,7 +89,7 @@ questions. <listitem><para> gtk-devel-list is for discussion of work on GTK+ (and GLib) itself, it is <emphasis>not</emphasis> for asking questions about how to use GTK+ (or GLib) -in applications. gtk-devel-list is appropriate for discussion of patches, +in applications. gtk-devel-list is appropriate for discussion of branches, bugs, proposed features, and so on. </para></listitem> </varlistentry> diff --git a/docs/reference/glib/xml/meson.build b/docs/reference/glib/xml/meson.build index 6d1e295b8..6aeb74514 100644 --- a/docs/reference/glib/xml/meson.build +++ b/docs/reference/glib/xml/meson.build @@ -1,6 +1,6 @@ ent_conf = configuration_data() ent_conf.set('PACKAGE', 'glib') -ent_conf.set('PACKAGE_BUGREPORT', 'https://bugzilla.gnome.org/enter_bug.cgi?product=glib') +ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/glib/issues/new') ent_conf.set('PACKAGE_NAME', 'glib') ent_conf.set('PACKAGE_STRING', 'glib') ent_conf.set('PACKAGE_TARNAME', 'glib') diff --git a/docs/reference/gobject/Makefile.am b/docs/reference/gobject/Makefile.am index 430ab6d5f..6efe781e1 100644 --- a/docs/reference/gobject/Makefile.am +++ b/docs/reference/gobject/Makefile.am @@ -13,6 +13,7 @@ DOC_SOURCE_DIR =$(top_srcdir)/gobject $(top_builddir)/gobject # Extra options to supply to gtkdoc-scan SCAN_OPTIONS = \ + --rebuild-types \ --deprecated-guards="G_DISABLE_DEPRECATED" \ --ignore-decorators="GLIB_VAR|G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT|GLIB_AVAILABLE_IN_ALL|GLIB_AVAILABLE_IN_2_26|GLIB_AVAILABLE_IN_2_28|GLIB_AVAILABLE_IN_2_30|GLIB_AVAILABLE_IN_2_32|GLIB_AVAILABLE_IN_2_34|GLIB_AVAILABLE_IN_2_36|GLIB_AVAILABLE_IN_2_38|GLIB_AVAILABLE_IN_2_40|GLIB_AVAILABLE_IN_2_42|GLIB_AVAILABLE_IN_2_44|GLIB_AVAILABLE_IN_2_46|GLIB_AVAILABLE_IN_2_48|GLIB_AVAILABLE_IN_2_50|GLIB_AVAILABLE_IN_2_52|GLIB_AVAILABLE_IN_2_54|GLIB_AVAILABLE_IN_2_56|GLIB_DEPRECATED_IN_2_26|GLIB_DEPRECATED_IN_2_26_FOR|GLIB_DEPRECATED_IN_2_28|GLIB_DEPRECATED_IN_2_28_FOR|GLIB_DEPRECATED_IN_2_30|GLIB_DEPRECATED_IN_2_30_FOR|GLIB_DEPRECATED_IN_2_32|GLIB_DEPRECATED_IN_2_32_FOR|GLIB_DEPRECATED_IN_2_34|GLIB_DEPRECATED_IN_2_34_FOR|GLIB_DEPRECATED_IN_2_36|GLIB_DEPRECATED_IN_2_36_FOR|GLIB_DEPRECATED_IN_2_38|GLIB_DEPRECATED_IN_2_38_FOR|GLIB_DEPRECATED_IN_2_40|GLIB_DEPRECATED_IN_2_40_FOR|GLIB_DEPRECATED_IN_2_42|GLIB_DEPRECATED_IN_2_42_FOR|GLIB_DEPRECATED_IN_2_44|GLIB_DEPRECATED_IN_2_44_FOR|GLIB_DEPRECATED_IN_2_46|GLIB_DEPRECATED_IN_2_46_FOR|GLIB_DEPRECATED_IN_2_48|GLIB_DEPRECATED_IN_2_48_FOR|GLIB_DEPRECATED_IN_2_50|GLIB_DEPRECATED_IN_2_50_FOR|GLIB_DEPRECATED_IN_2_52|GLIB_DEPRECATED_IN_2_52_FOR|GLIB_DEPRECATED_IN_2_54|GLIB_DEPRECATED_IN_2_54_FOR|GLIB_DEPRECATED_IN_2_56|GLIB_DEPRECATED_IN_2_56_FOR" @@ -64,7 +65,6 @@ include $(top_srcdir)/gtk-doc.make # Other files to distribute EXTRA_DIST += \ - gobject.cI \ version.xml.in ######################################################################## @@ -95,8 +95,6 @@ endif CLEANFILES ?= CLEANFILES += $(man_MANS) -EXTRA_DIST += $(man_MANS) - dist-hook-local: all-local gobject-docs-clean: clean diff --git a/docs/reference/gobject/gobject-docs.xml b/docs/reference/gobject/gobject-docs.xml index 646d91a91..f045df5b3 100644 --- a/docs/reference/gobject/gobject-docs.xml +++ b/docs/reference/gobject/gobject-docs.xml @@ -188,6 +188,14 @@ <title>Index of new symbols in 2.46</title> <xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include> </index> + <index id="api-index-2-54" role="2.54"> + <title>Index of new symbols in 2.54</title> + <xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-2-56" role="2.56"> + <title>Index of new symbols in 2.56</title> + <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include> + </index> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> diff --git a/docs/reference/gobject/gobject.cI b/docs/reference/gobject/gobject.cI deleted file mode 100644 index 2976940e3..000000000 --- a/docs/reference/gobject/gobject.cI +++ /dev/null @@ -1,11 +0,0 @@ -/* - * This is a hack to work around a limitation of gtkdoc-scan: it insists - * on putting () behind every symbol listed in gobject.types. Thus we - * can't put G_TYPE_OBJECT there, but have to sneak a g_object_get_type() - * function in the generated source via an #include. - */ -GType -g_object_get_type (void) -{ - return G_TYPE_OBJECT; -} diff --git a/docs/reference/gobject/gobject.types b/docs/reference/gobject/gobject.types deleted file mode 100644 index bb4e7b875..000000000 --- a/docs/reference/gobject/gobject.types +++ /dev/null @@ -1,7 +0,0 @@ -#include <glib/glib-object.h> -#include "gobject.cI" - -g_binding_get_type -g_object_get_type -g_type_module_get_type -g_type_plugin_get_type diff --git a/docs/reference/gobject/meson.build b/docs/reference/gobject/meson.build index de46cf96d..ac2da57d9 100644 --- a/docs/reference/gobject/meson.build +++ b/docs/reference/gobject/meson.build @@ -77,12 +77,12 @@ if get_option('gtk_doc') gnome.gtkdoc('gobject', main_xml : 'gobject-docs.xml', namespace : 'g', - gobject_typesfile : join_paths(meson.current_source_dir(), 'gobject.types'), mode : 'none', dependencies : [libgobject_dep, libglib_dep], include_directories : [gtkdocincl], src_dir : 'gobject', scan_args : [ + '--rebuild-types', '--deprecated-guards=G_DISABLE_DEPRECATED', '--ignore-decorators=' + '|'.join(ignore_decorators), '--ignore-headers=' + ' '.join(ignore_headers), diff --git a/docs/reference/gobject/tut_howto.xml b/docs/reference/gobject/tut_howto.xml index 0e119009b..daaad4697 100644 --- a/docs/reference/gobject/tut_howto.xml +++ b/docs/reference/gobject/tut_howto.xml @@ -1071,6 +1071,20 @@ viewer_file_init (ViewerFile *self) } </programlisting></informalexample> </para> + <para> + If the object is not of final type, e.g. was declared using + <function><link linkend="G-DECLARE-DERIVABLE-TYPE:CAPS">G_DECLARE_DERIVABLE_TYPE</link></function> + then + <function><link linkend="G-ADD-PRIVATE:CAPS">G_ADD_PRIVATE</link></function> + macro should be added. The private structure should be declared exactly + as for a normal derivable object, see <xref linkend="howto-gobject-code"/>. +<informalexample><programlisting> +G_DEFINE_TYPE_WITH_CODE (ViewerFile, viewer_file, G_TYPE_OBJECT, + G_ADD_PRIVATE (ViewerFile) + G_IMPLEMENT_INTERFACE (VIEWER_TYPE_EDITABLE, + viewer_file_editable_interface_init)) +</programlisting></informalexample> + </para> </sect1> <sect1 id="howto-interface-prerequisite"> diff --git a/docs/reference/gobject/xml/meson.build b/docs/reference/gobject/xml/meson.build index 6d1e295b8..6aeb74514 100644 --- a/docs/reference/gobject/xml/meson.build +++ b/docs/reference/gobject/xml/meson.build @@ -1,6 +1,6 @@ ent_conf = configuration_data() ent_conf.set('PACKAGE', 'glib') -ent_conf.set('PACKAGE_BUGREPORT', 'https://bugzilla.gnome.org/enter_bug.cgi?product=glib') +ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/glib/issues/new') ent_conf.set('PACKAGE_NAME', 'glib') ent_conf.set('PACKAGE_STRING', 'glib') ent_conf.set('PACKAGE_TARNAME', 'glib') |