GNOME Bugzilla – Bug 313661
problems with gtk-docs and exported symbols
Last modified: 2005-12-03 01:08:27 UTC
The gtk-docs for gnome-vfs are in poor shape, many functions do not have documentation, arguments and return codes are frequently undocumented. I notice gnome_vfs_create_uri_as_channel and gnome_vfs_set_meta_for_list seem to be in the gtk-docs but are not exported symbols. Note bug 152336 which probably can be closed, instead keeping all gtk-docs bugs for libgnomevfs in one place. I notice the following functions have been added since GNOME 2.0 and do not have "Since:" tags. Also listed are functions that have been removed from the library. Since gnome-vfs is in the platform and is supposed to be following API/ABI rules, I'm not sure it is good for so many functions to have disappeared. Some of the "added" functions probably do not need docs (such as ones that start with the _ prefix), but libgnomevfs probably shouldn't be exporting these symbols. Many of the removed symbols are probably okay (the ones that start with the _ prefix) but there are a lot of "gnome_vfs" functions that seem to have been removed. Functions changed: (from libgnomevfs-2.so.0.0.0 to libgnomevfs-2.so.0.1000.1) Functions removed (92): gnome_vfs_async_job_add_callback gnome_vfs_async_job_callback_valid gnome_vfs_async_job_cancel_job_and_callbacks gnome_vfs_async_job_completed gnome_vfs_async_job_map_add_job gnome_vfs_async_job_map_assert_locked gnome_vfs_async_job_map_get_job gnome_vfs_async_job_map_init gnome_vfs_async_job_map_lock gnome_vfs_async_job_map_remove_job gnome_vfs_async_job_map_shutdown gnome_vfs_async_job_map_unlock gnome_vfs_async_job_remove_callback gnome_vfs_canonicalize_pathname gnome_vfs_configuration_add_directory gnome_vfs_configuration_get_methods_list gnome_vfs_configuration_get_module_path gnome_vfs_configuration_init gnome_vfs_configuration_uninit gnome_vfs_context_ref gnome_vfs_context_unref gnome_vfs_dispatch_module_callback gnome_vfs_file_date_tracker_date_has_changed gnome_vfs_file_date_tracker_free gnome_vfs_file_date_tracker_new gnome_vfs_file_date_tracker_start_tracking_file gnome_vfs_get_current_context gnome_vfs_get_mime_type_internal gnome_vfs_handle_destroy gnome_vfs_handle_do_close gnome_vfs_handle_do_get_file_info gnome_vfs_handle_do_read gnome_vfs_handle_do_seek gnome_vfs_handle_do_tell gnome_vfs_handle_do_truncate gnome_vfs_handle_do_write gnome_vfs_handle_get_open_mode gnome_vfs_handle_new gnome_vfs_inet_connection_get_iobuf gnome_vfs_iobuf_destroy gnome_vfs_iobuf_flush gnome_vfs_iobuf_new gnome_vfs_iobuf_peekc gnome_vfs_iobuf_read gnome_vfs_iobuf_write gnome_vfs_istr_has_prefix gnome_vfs_istr_has_suffix gnome_vfs_job_complete gnome_vfs_job_create_slave gnome_vfs_job_destroy gnome_vfs_job_execute gnome_vfs_job_go gnome_vfs_job_module_cancel gnome_vfs_job_new gnome_vfs_job_queue_init gnome_vfs_job_queue_run gnome_vfs_job_queue_shutdown gnome_vfs_job_schedule gnome_vfs_job_set gnome_vfs_mime_clear_magic_table gnome_vfs_mime_dump_magic_table gnome_vfs_mime_get_type_from_magic_table gnome_vfs_mime_info_shutdown gnome_vfs_mime_magic_parse gnome_vfs_mime_monitor_emit_data_changed gnome_vfs_mime_sniff_buffer_get gnome_vfs_mime_sniff_buffer_new_from_handle gnome_vfs_mime_sniff_buffer_new_from_memory gnome_vfs_mime_sniff_buffer_new_generic gnome_vfs_mime_test_get_magic_table gnome_vfs_module_callback_clear_stacks gnome_vfs_module_callback_free_stack_info gnome_vfs_module_callback_get_stack_info gnome_vfs_module_callback_private_init gnome_vfs_module_callback_set_in_async_thread gnome_vfs_module_callback_use_stack_info gnome_vfs_monitor_do_add gnome_vfs_monitor_do_cancel gnome_vfs_process_free gnome_vfs_process_init gnome_vfs_process_new gnome_vfs_process_signal gnome_vfs_sniff_buffer_looks_like_gzip gnome_vfs_sniff_buffer_looks_like_mp3 gnome_vfs_sniff_buffer_looks_like_text gnome_vfs_ssl_init gnome_vfs_thread_backend_shutdown gnome_vfs_thread_create gnome_vfs_thread_pool_init gnome_vfs_thread_pool_shutdown gnome_vfs_xfer_private str_cmp_callback Functions added (441): GNOME_VFS_AsyncDaemon_Cancel GNOME_VFS_AsyncDaemon_CheckSameFS GNOME_VFS_AsyncDaemon_Create GNOME_VFS_AsyncDaemon_CreateSymbolicLink GNOME_VFS_AsyncDaemon_FindDirectory GNOME_VFS_AsyncDaemon_GetFileInfo GNOME_VFS_AsyncDaemon_IsLocal GNOME_VFS_AsyncDaemon_MakeDirectory GNOME_VFS_AsyncDaemon_MonitorAdd GNOME_VFS_AsyncDaemon_Move GNOME_VFS_AsyncDaemon_Open GNOME_VFS_AsyncDaemon_OpenDirectory GNOME_VFS_AsyncDaemon_RemoveDirectory GNOME_VFS_AsyncDaemon_SetFileInfo GNOME_VFS_AsyncDaemon_Truncate GNOME_VFS_AsyncDaemon_Unlink GNOME_VFS_ClientCall_ModuleCallbackInvoke GNOME_VFS_Client_DriveConnected GNOME_VFS_Client_DriveDisconnected GNOME_VFS_Client_MonitorCallback GNOME_VFS_Client_VolumeMounted GNOME_VFS_Client_VolumePreUnmount GNOME_VFS_Client_VolumeUnmounted GNOME_VFS_DaemonDirHandle_Close GNOME_VFS_DaemonDirHandle_Read GNOME_VFS_DaemonHandle_Close GNOME_VFS_DaemonHandle_GetFileInfo GNOME_VFS_DaemonHandle_Read GNOME_VFS_DaemonHandle_Seek GNOME_VFS_DaemonHandle_Tell GNOME_VFS_DaemonHandle_Truncate GNOME_VFS_DaemonHandle_Write GNOME_VFS_DaemonMonitor_Cancel GNOME_VFS_Daemon_deRegisterClient GNOME_VFS_Daemon_deRegisterVolumeMonitor GNOME_VFS_Daemon_emitPreUnmountVolume GNOME_VFS_Daemon_forceProbe GNOME_VFS_Daemon_getDrives GNOME_VFS_Daemon_getVolumes GNOME_VFS_Daemon_registerClient GNOME_VFS_Daemon_registerVolumeMonitor POA_GNOME_VFS_AsyncDaemon__fini POA_GNOME_VFS_AsyncDaemon__init POA_GNOME_VFS_ClientCall__fini POA_GNOME_VFS_ClientCall__init POA_GNOME_VFS_Client__fini POA_GNOME_VFS_Client__init POA_GNOME_VFS_DaemonDirHandle__fini POA_GNOME_VFS_DaemonDirHandle__init POA_GNOME_VFS_DaemonHandle__fini POA_GNOME_VFS_DaemonHandle__init POA_GNOME_VFS_DaemonMonitor__fini POA_GNOME_VFS_DaemonMonitor__init POA_GNOME_VFS_Daemon__fini POA_GNOME_VFS_Daemon__init _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Cancel _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_CheckSameFS _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Create _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_CreateSymbolicLink _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_FindDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_GetFileInfo _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_IsLocal _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_MakeDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_MonitorAdd _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Move _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Open _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_OpenDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_RemoveDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_SetFileInfo _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Truncate _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Unlink _ORBIT_skel_small_GNOME_VFS_ClientCall_ModuleCallbackInvoke _ORBIT_skel_small_GNOME_VFS_Client_DriveConnected _ORBIT_skel_small_GNOME_VFS_Client_DriveDisconnected _ORBIT_skel_small_GNOME_VFS_Client_MonitorCallback _ORBIT_skel_small_GNOME_VFS_Client_VolumeMounted _ORBIT_skel_small_GNOME_VFS_Client_VolumePreUnmount _ORBIT_skel_small_GNOME_VFS_Client_VolumeUnmounted _ORBIT_skel_small_GNOME_VFS_DaemonDirHandle_Close _ORBIT_skel_small_GNOME_VFS_DaemonDirHandle_Read _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Close _ORBIT_skel_small_GNOME_VFS_DaemonHandle_GetFileInfo _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Read _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Seek _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Tell _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Truncate _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Write _ORBIT_skel_small_GNOME_VFS_DaemonMonitor_Cancel _ORBIT_skel_small_GNOME_VFS_Daemon_deRegisterClient _ORBIT_skel_small_GNOME_VFS_Daemon_deRegisterVolumeMonitor _ORBIT_skel_small_GNOME_VFS_Daemon_emitPreUnmountVolume _ORBIT_skel_small_GNOME_VFS_Daemon_forceProbe _ORBIT_skel_small_GNOME_VFS_Daemon_getDrives _ORBIT_skel_small_GNOME_VFS_Daemon_getVolumes _ORBIT_skel_small_GNOME_VFS_Daemon_registerClient _ORBIT_skel_small_GNOME_VFS_Daemon_registerVolumeMonitor _gnome_vfs_async_job_add_callback _gnome_vfs_async_job_callback_valid _gnome_vfs_async_job_cancel_job_and_callbacks _gnome_vfs_async_job_completed _gnome_vfs_async_job_map_add_job _gnome_vfs_async_job_map_assert_locked _gnome_vfs_async_job_map_get_job _gnome_vfs_async_job_map_init _gnome_vfs_async_job_map_lock _gnome_vfs_async_job_map_remove_job _gnome_vfs_async_job_map_shutdown _gnome_vfs_async_job_map_unlock _gnome_vfs_async_job_remove_callback _gnome_vfs_cancellation_add_client_call _gnome_vfs_cancellation_remove_client_call _gnome_vfs_canonicalize_pathname _gnome_vfs_clear_fd_flags _gnome_vfs_client_call_delay_finish _gnome_vfs_client_call_delay_finish_done _gnome_vfs_client_call_destroy _gnome_vfs_client_call_finished _gnome_vfs_client_call_get _gnome_vfs_client_get_async_daemon _gnome_vfs_client_get_daemon _gnome_vfs_client_shutdown _gnome_vfs_configuration_add_directory _gnome_vfs_configuration_get_methods_list _gnome_vfs_configuration_get_module_path _gnome_vfs_configuration_init _gnome_vfs_configuration_uninit _gnome_vfs_daemon_get_current_daemon_client_call _gnome_vfs_daemon_method_get _gnome_vfs_device_type_get_sort_group _gnome_vfs_dispatch_module_callback _gnome_vfs_drive_add_mounted_volume _gnome_vfs_drive_from_corba _gnome_vfs_drive_remove_volume _gnome_vfs_file_date_tracker_date_has_changed _gnome_vfs_file_date_tracker_free _gnome_vfs_file_date_tracker_new _gnome_vfs_file_date_tracker_start_tracking_file _gnome_vfs_filesystem_use_trash _gnome_vfs_filesystem_volume_name _gnome_vfs_get_cdrom_type _gnome_vfs_get_client _gnome_vfs_get_client_poa _gnome_vfs_get_client_policy _gnome_vfs_get_current_context _gnome_vfs_get_daemon_force_probe_callback _gnome_vfs_get_daemon_volume_monitor_type _gnome_vfs_get_iso9660_volume_name _gnome_vfs_get_mime_type_internal _gnome_vfs_get_slow_mime_type _gnome_vfs_get_volume_monitor_internal _gnome_vfs_handle_destroy _gnome_vfs_handle_do_close _gnome_vfs_handle_do_file_control _gnome_vfs_handle_do_get_file_info _gnome_vfs_handle_do_read _gnome_vfs_handle_do_seek _gnome_vfs_handle_do_tell _gnome_vfs_handle_do_truncate _gnome_vfs_handle_do_write _gnome_vfs_handle_forget_cache _gnome_vfs_handle_get_open_mode _gnome_vfs_handle_new _gnome_vfs_have_ipv6 _gnome_vfs_istr_has_prefix _gnome_vfs_istr_has_suffix _gnome_vfs_job_complete _gnome_vfs_job_create_slave _gnome_vfs_job_destroy _gnome_vfs_job_execute _gnome_vfs_job_go _gnome_vfs_job_module_cancel _gnome_vfs_job_new _gnome_vfs_job_queue_init _gnome_vfs_job_queue_run _gnome_vfs_job_queue_shutdown _gnome_vfs_job_schedule _gnome_vfs_job_set _gnome_vfs_mime_info_cache_init _gnome_vfs_mime_info_shutdown _gnome_vfs_mime_monitor_emit_data_changed _gnome_vfs_mime_sniff_buffer_get _gnome_vfs_mime_sniff_buffer_new_from_handle _gnome_vfs_mime_sniff_buffer_new_from_memory _gnome_vfs_mime_sniff_buffer_new_generic _gnome_vfs_module_callback_clear_stacks _gnome_vfs_module_callback_demarshal_invoke _gnome_vfs_module_callback_free_stack_info _gnome_vfs_module_callback_get_stack_info _gnome_vfs_module_callback_marshal_invoke _gnome_vfs_module_callback_private_init _gnome_vfs_module_callback_set_in_async_thread _gnome_vfs_module_callback_use_stack_info _gnome_vfs_monitor_do_add _gnome_vfs_monitor_do_cancel _gnome_vfs_prepend_terminal_to_vector _gnome_vfs_process_free _gnome_vfs_process_init _gnome_vfs_process_new _gnome_vfs_process_signal _gnome_vfs_set_fd_flags _gnome_vfs_sniff_buffer_looks_like_mp3 _gnome_vfs_sniff_buffer_looks_like_text _gnome_vfs_ssl_init _gnome_vfs_thread_backend_shutdown _gnome_vfs_thread_create _gnome_vfs_thread_pool_init _gnome_vfs_thread_pool_shutdown _gnome_vfs_uri_is_in_subdir _gnome_vfs_uri_resolve_all_symlinks _gnome_vfs_uri_resolve_all_symlinks_uri _gnome_vfs_url_show_using_handler_with_env _gnome_vfs_use_handler_for_scheme _gnome_vfs_volume_from_corba _gnome_vfs_volume_monitor_client_daemon_died _gnome_vfs_volume_monitor_client_shutdown _gnome_vfs_volume_monitor_connected _gnome_vfs_volume_monitor_disconnect_all _gnome_vfs_volume_monitor_disconnected _gnome_vfs_volume_monitor_find_connected_server_by_gconf_id _gnome_vfs_volume_monitor_find_drive_by_device_path _gnome_vfs_volume_monitor_find_fstab_drive_by_activation_uri _gnome_vfs_volume_monitor_find_mtab_volume_by_activation_uri _gnome_vfs_volume_monitor_find_volume_by_device_path _gnome_vfs_volume_monitor_mounted _gnome_vfs_volume_monitor_shutdown _gnome_vfs_volume_monitor_uniquify_drive_name _gnome_vfs_volume_monitor_uniquify_volume_name _gnome_vfs_volume_monitor_unmount_all _gnome_vfs_volume_monitor_unmounted _gnome_vfs_volume_set_drive _gnome_vfs_volume_unset_drive _gnome_vfs_xdg_alias_list_free _gnome_vfs_xdg_alias_list_lookup _gnome_vfs_xdg_alias_list_new _gnome_vfs_xdg_alias_read_from_file _gnome_vfs_xdg_determine_type _gnome_vfs_xdg_get_ase_name _gnome_vfs_xdg_get_max_buffer_extents _gnome_vfs_xdg_get_mime_parents _gnome_vfs_xdg_get_mime_type_for_data _gnome_vfs_xdg_get_mime_type_for_file _gnome_vfs_xdg_get_mime_type_from_file_name _gnome_vfs_xdg_glob_read_from_file _gnome_vfs_xdg_hash_append_glob _gnome_vfs_xdg_hash_dump _gnome_vfs_xdg_hash_free _gnome_vfs_xdg_hash_lookup_file_name _gnome_vfs_xdg_hash_new _gnome_vfs_xdg_is_valid_mime_type _gnome_vfs_xdg_magic_free _gnome_vfs_xdg_magic_get_buffer_extents _gnome_vfs_xdg_magic_lookup_data _gnome_vfs_xdg_magic_new _gnome_vfs_xdg_magic_read_from_file _gnome_vfs_xdg_media_type_equal _gnome_vfs_xdg_mime_type_equal _gnome_vfs_xdg_mime_type_subclass _gnome_vfs_xdg_parent_list_free _gnome_vfs_xdg_parent_list_lookup _gnome_vfs_xdg_parent_list_new _gnome_vfs_xdg_parent_read_from_file _gnome_vfs_xdg_register_reload_callback _gnome_vfs_xdg_remove_callback _gnome_vfs_xdg_shutdown _gnome_vfs_xdg_ucs4_to_lower _gnome_vfs_xdg_unalias_mime_type _gnome_vfs_xdg_utf8_to_ucs4 _gnome_vfs_xdg_utf8_validate _gnome_vfs_xfer_private _xdg_mime_alias_list_dump _xdg_mime_parent_list_dump gnome_vfs_address_dup gnome_vfs_address_free gnome_vfs_address_get_sockaddr gnome_vfs_address_get_type gnome_vfs_async_file_control gnome_vfs_async_seek gnome_vfs_client_call_get_type gnome_vfs_client_get_type gnome_vfs_context_free gnome_vfs_daemon_convert_from_corba_file_info gnome_vfs_daemon_convert_to_corba_file_info gnome_vfs_daemon_set_current_daemon_client_call gnome_vfs_device_type_get_type gnome_vfs_directory_visit_options_get_type gnome_vfs_dns_sd_browse gnome_vfs_dns_sd_browse_sync gnome_vfs_dns_sd_cancel_resolve gnome_vfs_dns_sd_list_browse_domains_sync gnome_vfs_dns_sd_resolve gnome_vfs_dns_sd_resolve_sync gnome_vfs_dns_sd_service_list_free gnome_vfs_dns_sd_service_status_get_type gnome_vfs_dns_sd_stop_browse gnome_vfs_drive_to_corba gnome_vfs_file_control gnome_vfs_file_control_cancellable gnome_vfs_file_flags_get_type gnome_vfs_file_info_fields_get_type gnome_vfs_file_info_get_type gnome_vfs_file_info_options_get_type gnome_vfs_file_permissions_get_type gnome_vfs_file_type_get_type gnome_vfs_find_directory_kind_get_type gnome_vfs_forget_cache gnome_vfs_get_default_browse_domains gnome_vfs_get_file_mime_type_fast gnome_vfs_get_is_daemon gnome_vfs_inet_connection_free gnome_vfs_inet_connection_to_socket_buffer gnome_vfs_make_uri_dirs_get_type gnome_vfs_mime_action_launch gnome_vfs_mime_action_launch_with_env gnome_vfs_mime_action_type_get_type gnome_vfs_mime_application_argument_type_get_type gnome_vfs_mime_application_equal gnome_vfs_mime_application_get_desktop_id gnome_vfs_mime_equivalence_get_type gnome_vfs_mime_get_all_applications_for_uri gnome_vfs_mime_get_all_desktop_entries gnome_vfs_mime_get_default_application_for_uri gnome_vfs_mime_get_default_desktop_entry gnome_vfs_mime_info_cache_reload gnome_vfs_mime_reload gnome_vfs_mime_type_get_equivalence gnome_vfs_mime_type_is_equal gnome_vfs_module_callback_full_authentication_flags_get_type gnome_vfs_module_callback_full_authentication_out_flags_get_type gnome_vfs_monitor_event_type_get_type gnome_vfs_monitor_type_get_type gnome_vfs_open_fd gnome_vfs_open_mode_get_type gnome_vfs_result_from_h_errno_val gnome_vfs_result_get_type gnome_vfs_seek_position_get_type gnome_vfs_set_file_info_mask_get_type gnome_vfs_set_is_daemon gnome_vfs_uri_hide_options_get_type gnome_vfs_volume_get_type gnome_vfs_volume_monitor_client_get_type gnome_vfs_volume_monitor_get_type gnome_vfs_volume_to_corba gnome_vfs_volume_type_get_type gnome_vfs_xfer_error_action_get_type gnome_vfs_xfer_error_mode_get_type gnome_vfs_xfer_options_get_type gnome_vfs_xfer_overwrite_action_get_type gnome_vfs_xfer_overwrite_mode_get_type gnome_vfs_xfer_phase_get_type gnome_vfs_xfer_progress_status_get_type xdg_mime_dump Also, the following functions seem to be exported missing documentation. Probably some of them shouldn't be exported and do not need docs: GNOME_VFS_AsyncDaemon_Cancel GNOME_VFS_AsyncDaemon_CheckSameFS GNOME_VFS_AsyncDaemon_Create GNOME_VFS_AsyncDaemon_CreateSymbolicLink GNOME_VFS_AsyncDaemon_FindDirectory GNOME_VFS_AsyncDaemon_GetFileInfo GNOME_VFS_AsyncDaemon_IsLocal GNOME_VFS_AsyncDaemon_MakeDirectory GNOME_VFS_AsyncDaemon_MonitorAdd GNOME_VFS_AsyncDaemon_Move GNOME_VFS_AsyncDaemon_Open GNOME_VFS_AsyncDaemon_OpenDirectory GNOME_VFS_AsyncDaemon_RemoveDirectory GNOME_VFS_AsyncDaemon_SetFileInfo GNOME_VFS_AsyncDaemon_Truncate GNOME_VFS_AsyncDaemon_Unlink GNOME_VFS_ClientCall_ModuleCallbackInvoke GNOME_VFS_Client_DriveConnected GNOME_VFS_Client_DriveDisconnected GNOME_VFS_Client_MonitorCallback GNOME_VFS_Client_VolumeMounted GNOME_VFS_Client_VolumePreUnmount GNOME_VFS_Client_VolumeUnmounted GNOME_VFS_DaemonDirHandle_Close GNOME_VFS_DaemonDirHandle_Read GNOME_VFS_DaemonHandle_Close GNOME_VFS_DaemonHandle_GetFileInfo GNOME_VFS_DaemonHandle_Read GNOME_VFS_DaemonHandle_Seek GNOME_VFS_DaemonHandle_Tell GNOME_VFS_DaemonHandle_Truncate GNOME_VFS_DaemonHandle_Write GNOME_VFS_DaemonMonitor_Cancel GNOME_VFS_Daemon_deRegisterClient GNOME_VFS_Daemon_deRegisterVolumeMonitor GNOME_VFS_Daemon_emitPreUnmountVolume GNOME_VFS_Daemon_forceProbe GNOME_VFS_Daemon_getDrives GNOME_VFS_Daemon_getVolumes GNOME_VFS_Daemon_registerClient GNOME_VFS_Daemon_registerVolumeMonitor POA_GNOME_VFS_AsyncDaemon__fini POA_GNOME_VFS_AsyncDaemon__init POA_GNOME_VFS_ClientCall__fini POA_GNOME_VFS_ClientCall__init POA_GNOME_VFS_Client__fini POA_GNOME_VFS_Client__init POA_GNOME_VFS_DaemonDirHandle__fini POA_GNOME_VFS_DaemonDirHandle__init POA_GNOME_VFS_DaemonHandle__fini POA_GNOME_VFS_DaemonHandle__init POA_GNOME_VFS_DaemonMonitor__fini POA_GNOME_VFS_DaemonMonitor__init POA_GNOME_VFS_Daemon__fini POA_GNOME_VFS_Daemon__init _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Cancel _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_CheckSameFS _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Create _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_CreateSymbolicLink _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_FindDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_GetFileInfo _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_IsLocal _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_MakeDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_MonitorAdd _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Move _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Open _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_OpenDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_RemoveDirectory _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_SetFileInfo _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Truncate _ORBIT_skel_small_GNOME_VFS_AsyncDaemon_Unlink _ORBIT_skel_small_GNOME_VFS_ClientCall_ModuleCallbackInvoke _ORBIT_skel_small_GNOME_VFS_Client_DriveConnected _ORBIT_skel_small_GNOME_VFS_Client_DriveDisconnected _ORBIT_skel_small_GNOME_VFS_Client_MonitorCallback _ORBIT_skel_small_GNOME_VFS_Client_VolumeMounted _ORBIT_skel_small_GNOME_VFS_Client_VolumePreUnmount _ORBIT_skel_small_GNOME_VFS_Client_VolumeUnmounted _ORBIT_skel_small_GNOME_VFS_DaemonDirHandle_Close _ORBIT_skel_small_GNOME_VFS_DaemonDirHandle_Read _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Close _ORBIT_skel_small_GNOME_VFS_DaemonHandle_GetFileInfo _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Read _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Seek _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Tell _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Truncate _ORBIT_skel_small_GNOME_VFS_DaemonHandle_Write _ORBIT_skel_small_GNOME_VFS_DaemonMonitor_Cancel _ORBIT_skel_small_GNOME_VFS_Daemon_deRegisterClient _ORBIT_skel_small_GNOME_VFS_Daemon_deRegisterVolumeMonitor _ORBIT_skel_small_GNOME_VFS_Daemon_emitPreUnmountVolume _ORBIT_skel_small_GNOME_VFS_Daemon_forceProbe _ORBIT_skel_small_GNOME_VFS_Daemon_getDrives _ORBIT_skel_small_GNOME_VFS_Daemon_getVolumes _ORBIT_skel_small_GNOME_VFS_Daemon_registerClient _ORBIT_skel_small_GNOME_VFS_Daemon_registerVolumeMonitor _gnome_vfs_async_job_add_callback _gnome_vfs_async_job_callback_valid _gnome_vfs_async_job_cancel_job_and_callbacks _gnome_vfs_async_job_completed _gnome_vfs_async_job_map_add_job _gnome_vfs_async_job_map_assert_locked _gnome_vfs_async_job_map_get_job _gnome_vfs_async_job_map_init _gnome_vfs_async_job_map_lock _gnome_vfs_async_job_map_remove_job _gnome_vfs_async_job_map_shutdown _gnome_vfs_async_job_map_unlock _gnome_vfs_async_job_remove_callback _gnome_vfs_cancellation_add_client_call _gnome_vfs_cancellation_remove_client_call _gnome_vfs_canonicalize_pathname _gnome_vfs_clear_fd_flags _gnome_vfs_client_call_delay_finish _gnome_vfs_client_call_delay_finish_done _gnome_vfs_client_call_destroy _gnome_vfs_client_call_finished _gnome_vfs_client_call_get _gnome_vfs_client_get_async_daemon _gnome_vfs_client_get_daemon _gnome_vfs_client_shutdown _gnome_vfs_configuration_add_directory _gnome_vfs_configuration_get_methods_list _gnome_vfs_configuration_get_module_path _gnome_vfs_configuration_init _gnome_vfs_configuration_uninit _gnome_vfs_daemon_get_current_daemon_client_call _gnome_vfs_daemon_method_get _gnome_vfs_device_type_get_sort_group _gnome_vfs_dispatch_module_callback _gnome_vfs_drive_add_mounted_volume _gnome_vfs_drive_from_corba _gnome_vfs_drive_remove_volume _gnome_vfs_file_date_tracker_date_has_changed _gnome_vfs_file_date_tracker_free _gnome_vfs_file_date_tracker_new _gnome_vfs_file_date_tracker_start_tracking_file _gnome_vfs_filesystem_use_trash _gnome_vfs_filesystem_volume_name _gnome_vfs_get_cdrom_type _gnome_vfs_get_client _gnome_vfs_get_client_poa _gnome_vfs_get_client_policy _gnome_vfs_get_current_context _gnome_vfs_get_daemon_force_probe_callback _gnome_vfs_get_daemon_volume_monitor_type _gnome_vfs_get_iso9660_volume_name _gnome_vfs_get_mime_type_internal _gnome_vfs_get_slow_mime_type _gnome_vfs_get_volume_monitor_internal _gnome_vfs_handle_destroy _gnome_vfs_handle_do_close _gnome_vfs_handle_do_file_control _gnome_vfs_handle_do_get_file_info _gnome_vfs_handle_do_read _gnome_vfs_handle_do_seek _gnome_vfs_handle_do_tell _gnome_vfs_handle_do_truncate _gnome_vfs_handle_do_write _gnome_vfs_handle_forget_cache _gnome_vfs_handle_get_open_mode _gnome_vfs_handle_new _gnome_vfs_have_ipv6 _gnome_vfs_istr_has_prefix _gnome_vfs_istr_has_suffix _gnome_vfs_job_complete _gnome_vfs_job_create_slave _gnome_vfs_job_destroy _gnome_vfs_job_execute _gnome_vfs_job_go _gnome_vfs_job_module_cancel _gnome_vfs_job_new _gnome_vfs_job_queue_init _gnome_vfs_job_queue_run _gnome_vfs_job_queue_shutdown _gnome_vfs_job_schedule _gnome_vfs_job_set _gnome_vfs_mime_info_cache_init _gnome_vfs_mime_info_mark_gnome_mime_dir_dirty _gnome_vfs_mime_info_mark_user_mime_dir_dirty _gnome_vfs_mime_info_shutdown _gnome_vfs_mime_monitor_emit_data_changed _gnome_vfs_mime_sniff_buffer_get _gnome_vfs_mime_sniff_buffer_new_from_handle _gnome_vfs_mime_sniff_buffer_new_from_memory _gnome_vfs_mime_sniff_buffer_new_generic _gnome_vfs_module_callback_clear_stacks _gnome_vfs_module_callback_demarshal_invoke _gnome_vfs_module_callback_free_stack_info _gnome_vfs_module_callback_get_stack_info _gnome_vfs_module_callback_marshal_invoke _gnome_vfs_module_callback_private_init _gnome_vfs_module_callback_set_in_async_thread _gnome_vfs_module_callback_use_stack_info _gnome_vfs_monitor_do_add _gnome_vfs_monitor_do_cancel _gnome_vfs_prepend_terminal_to_vector _gnome_vfs_process_free _gnome_vfs_process_init _gnome_vfs_process_new _gnome_vfs_process_signal _gnome_vfs_set_fd_flags _gnome_vfs_sniff_buffer_looks_like_mp3 _gnome_vfs_sniff_buffer_looks_like_text _gnome_vfs_ssl_init _gnome_vfs_thread_backend_shutdown _gnome_vfs_thread_create _gnome_vfs_thread_pool_init _gnome_vfs_thread_pool_shutdown _gnome_vfs_uri_is_in_subdir _gnome_vfs_uri_resolve_all_symlinks _gnome_vfs_uri_resolve_all_symlinks_uri _gnome_vfs_url_show_using_handler_with_env _gnome_vfs_use_handler_for_scheme _gnome_vfs_volume_from_corba _gnome_vfs_volume_monitor_client_daemon_died _gnome_vfs_volume_monitor_client_shutdown _gnome_vfs_volume_monitor_connected _gnome_vfs_volume_monitor_disconnect_all _gnome_vfs_volume_monitor_disconnected _gnome_vfs_volume_monitor_find_connected_server_by_gconf_id _gnome_vfs_volume_monitor_find_drive_by_device_path _gnome_vfs_volume_monitor_find_fstab_drive_by_activation_uri _gnome_vfs_volume_monitor_find_mtab_volume_by_activation_uri _gnome_vfs_volume_monitor_find_volume_by_device_path _gnome_vfs_volume_monitor_mounted _gnome_vfs_volume_monitor_shutdown _gnome_vfs_volume_monitor_uniquify_drive_name _gnome_vfs_volume_monitor_uniquify_volume_name _gnome_vfs_volume_monitor_unmount_all _gnome_vfs_volume_monitor_unmounted _gnome_vfs_volume_set_drive _gnome_vfs_volume_unset_drive _gnome_vfs_xdg_alias_list_free _gnome_vfs_xdg_alias_list_lookup _gnome_vfs_xdg_alias_list_new _gnome_vfs_xdg_alias_read_from_file _gnome_vfs_xdg_determine_type _gnome_vfs_xdg_get_ase_name _gnome_vfs_xdg_get_max_buffer_extents _gnome_vfs_xdg_get_mime_parents _gnome_vfs_xdg_get_mime_type_for_data _gnome_vfs_xdg_get_mime_type_for_file _gnome_vfs_xdg_get_mime_type_from_file_name _gnome_vfs_xdg_glob_read_from_file _gnome_vfs_xdg_hash_append_glob _gnome_vfs_xdg_hash_dump _gnome_vfs_xdg_hash_free _gnome_vfs_xdg_hash_lookup_file_name _gnome_vfs_xdg_hash_new _gnome_vfs_xdg_is_valid_mime_type _gnome_vfs_xdg_magic_free _gnome_vfs_xdg_magic_get_buffer_extents _gnome_vfs_xdg_magic_lookup_data _gnome_vfs_xdg_magic_new _gnome_vfs_xdg_magic_read_from_file _gnome_vfs_xdg_media_type_equal _gnome_vfs_xdg_mime_type_equal _gnome_vfs_xdg_mime_type_subclass _gnome_vfs_xdg_parent_list_free _gnome_vfs_xdg_parent_list_lookup _gnome_vfs_xdg_parent_list_new _gnome_vfs_xdg_parent_read_from_file _gnome_vfs_xdg_register_reload_callback _gnome_vfs_xdg_remove_callback _gnome_vfs_xdg_shutdown _gnome_vfs_xdg_ucs4_to_lower _gnome_vfs_xdg_unalias_mime_type _gnome_vfs_xdg_utf8_to_ucs4 _gnome_vfs_xdg_utf8_validate _gnome_vfs_xfer_private _xdg_mime_alias_list_dump _xdg_mime_parent_list_dump async_job_callback_map_destroy gnome_vfs_address_dup gnome_vfs_address_free gnome_vfs_address_get_sockaddr gnome_vfs_atotm gnome_vfs_check_same_fs_uris_cancellable gnome_vfs_client_call_get_type gnome_vfs_client_get_type gnome_vfs_close_cancellable gnome_vfs_create_symbolic_link_cancellable gnome_vfs_create_temp gnome_vfs_create_uri_cancellable gnome_vfs_daemon_convert_from_corba_file_info gnome_vfs_daemon_convert_to_corba_file_info gnome_vfs_daemon_set_current_daemon_client_call gnome_vfs_device_type_get_type gnome_vfs_directory_open_from_uri_cancellable gnome_vfs_directory_read_next_cancellable gnome_vfs_directory_visit_options_get_type gnome_vfs_dns_sd_service_status_get_type gnome_vfs_drive_to_corba gnome_vfs_file_control_cancellable gnome_vfs_file_flags_get_type gnome_vfs_file_info_fields_get_type gnome_vfs_file_info_get_type gnome_vfs_file_info_options_get_type gnome_vfs_file_permissions_get_type gnome_vfs_file_type_get_type gnome_vfs_find_directory_cancellable gnome_vfs_find_directory_kind_get_type gnome_vfs_forget_cache gnome_vfs_forkexec gnome_vfs_get_file_info_from_handle_cancellable gnome_vfs_get_file_info_uri_cancellable gnome_vfs_get_file_mime_type_fast gnome_vfs_get_is_daemon gnome_vfs_get_mime_type_for_buffer gnome_vfs_i18n_get_language_list gnome_vfs_job_get_count gnome_vfs_make_directory_for_uri_cancellable gnome_vfs_make_uri_dirs_get_type gnome_vfs_mime_action_launch gnome_vfs_mime_action_launch_with_env gnome_vfs_mime_action_type_get_type gnome_vfs_mime_application_argument_type_get_type gnome_vfs_mime_application_equal gnome_vfs_mime_equivalence_get_type gnome_vfs_mime_get_all_applications_for_uri gnome_vfs_mime_get_all_desktop_entries gnome_vfs_mime_get_default_desktop_entry gnome_vfs_mime_info_cache_reload gnome_vfs_mime_monitor_get_type gnome_vfs_mime_reload gnome_vfs_mime_set_default_application gnome_vfs_mime_set_default_component gnome_vfs_mime_sniff_buffer_free gnome_vfs_mime_sniff_buffer_new_from_existing_data gnome_vfs_mime_type_get_equivalence gnome_vfs_mime_type_is_equal gnome_vfs_module_callback_full_authentication_flags_get_type gnome_vfs_module_callback_full_authentication_out_flags_get_type gnome_vfs_monitor_callback gnome_vfs_monitor_event_type_get_type gnome_vfs_monitor_type_get_type gnome_vfs_move_uri_cancellable gnome_vfs_open_fd gnome_vfs_open_mode_get_type gnome_vfs_open_uri_cancellable gnome_vfs_process_run_cancellable gnome_vfs_read_cancellable gnome_vfs_remove_directory_from_uri_cancellable gnome_vfs_remove_optional_escapes gnome_vfs_result_get_type gnome_vfs_seek_cancellable gnome_vfs_seek_position_get_type gnome_vfs_set_file_info_cancellable gnome_vfs_set_file_info_mask_get_type gnome_vfs_set_is_daemon gnome_vfs_truncate_handle_cancellable gnome_vfs_truncate_uri_cancellable gnome_vfs_unlink_from_uri_cancellable gnome_vfs_uri_hide_options_get_type gnome_vfs_uri_new_private gnome_vfs_volume_monitor_client_get_type gnome_vfs_volume_to_corba gnome_vfs_write_cancellable gnome_vfs_xfer_error_action_get_type gnome_vfs_xfer_error_mode_get_type gnome_vfs_xfer_options_get_type gnome_vfs_xfer_overwrite_action_get_type gnome_vfs_xfer_overwrite_mode_get_type gnome_vfs_xfer_phase_get_type gnome_vfs_xfer_progress_status_get_type xdg_mime_dump
I believe only the following functions that have been added need "Since:" tags since the "_get_type" functions are normally not documented: I've provided the version numbers for when the functions were added that I found in the ChangeLog. Unfortunately a lot of functions don't seem to have comments there. gnome_vfs_address_get_sockaddr 2.5.0 gnome_vfs_async_seek 2.1.2 gnome_vfs_context_free 2.5.3 gnome_vfs_daemon_convert_from_corba_file_info 2.5.3 gnome_vfs_daemon_convert_to_corba_file_info 2.5.3 gnome_vfs_daemon_set_current_daemon_client_call gnome_vfs_dns_sd_browse gnome_vfs_dns_sd_browse_sync gnome_vfs_dns_sd_cancel_resolve gnome_vfs_dns_sd_list_browse_domains_sync gnome_vfs_dns_sd_resolve gnome_vfs_dns_sd_resolve_sync gnome_vfs_dns_sd_service_list_free gnome_vfs_dns_sd_stop_browse 2.1.3.1 gnome_vfs_file_control 2.1.3.1 gnome_vfs_file_control_cancellable 2.11.1 gnome_vfs_forget_cache 2.7.3 gnome_vfs_get_default_browse_domains gnome_vfs_get_file_mime_type_fast gnome_vfs_get_is_daemon 2.7.4 gnome_vfs_inet_connection_free gnome_vfs_inet_connection_to_socket_buffer gnome_vfs_mime_application_get_desktop_id gnome_vfs_mime_get_all_desktop_entries 2.7.4 gnome_vfs_mime_get_default_desktop_entry 2.7.4 gnome_vfs_mime_info_cache_reload 2.7.4 gnome_vfs_mime_reload 2.7.4 gnome_vfs_mime_type_get_equivalence 2.7.4 gnome_vfs_mime_type_is_equal 2.7.4 gnome_vfs_result_from_h_errno_val gnome_vfs_set_is_daemon xdg_mime_dump I notice two other issues as well: gnome_vfs_make_uri_canonical listed since 2.2 but was in 2.0. gnome_vfs_open_fd is listed as gnome_vfs_open_fs in gtk-doc
oops, sorry about the extra comment. I notice gnome_vfs_forget_cache was added in 2.9.90 and not 2.11.1.
Yeah I know, the docs could be better. You don't happen to have time to cook up a patch for that, since I am pretty short on my time at the moment. I hope to get some work done on weekend though, but I am not sure to have time for docs. Btw, we only list stable version numbers in the Since tag so if you really do the patch just round them up to the next stable version, but I am sure you already knew that, just wanted to get sure! :)
Yes, I plan on spending some time in the next few weeks fixing up the docs for the various Platform libraries. Since gnome-vfs is probably the Platform library with the poorest interface documentation, I think I will start addressing this module first and get this resolved. However, at the moment I am still reviewing all Platform gtk-docs and filing bugs where I find issues. It'll probably take me a few days to get this done before I can start working on this patch. You could help me by doing the following: 1) Highlight which of the "added" and "undocumented" functions should really not be exported at all, and therefore should not have documentation. 2) Provide the reasoning why so many gnome_vfs functions were removed since GNOME 2.0. It's not good from an API/ABI stability perspective for functions to disappear. Instead they are normally deprecated. I assume there is probably a reason why this hasn't been a problem. Perhaps the removed functions were never really exposed to end users? 3) Any info you can provide about when the functions were added that I haven't been able to track down would be useful. Yes I know that we only use stable #'s in the "Since:" gtk-doc tag. I just listed the version that the interface was added to the library.
Note that gnome-vfs library number is 0.1000.0. Quite a few functions have been removed from gnome-vfs. If any of the removed functions were public, this should be bumped to 1.0.0 to indicate interface change.
The functions that were "removed" were never public, ie they were exported, but not present in any public header which meant people weren't supposed to be using them. Since then, such functions are better hidden, either by asking the linker not to export them at all, or by putting an _ at the beginnig of the function name (which mean you should prune the functions starting with an _ in your initial list of added functions).
Thanks for confirming that the removed interfaces were never public. That is good news to hear. I submitted bug 316529 with an enhancement request that gnome-vfs use --export-symbols-regexp to avoid exporting private interfaces. This should also help. That bug has a patch I put together that helps to resolve that problem. So now this bug is just about quite a number of interfaces in gnome-vfs that have poor documentation. We are going to start helping with this soon.
Created attachment 52449 [details] [review] Sample patch
Created attachment 52532 [details] [review] One more patch
Created attachment 52851 [details] [review] Patch file
Can this patch be applied? Marking high priority since there is no reason that this shouldn't be applied if there aren't issues with the patch.
Brian: I am almost through with an updated patch for this. It includes all the API's except the private interfaces which need to be prefixed with "_". I will put up the patch very soon. Probably the maintainers could wait a bit on the review for the moment. Hope that is fine.
Created attachment 54136 [details] [review] Patch-1
Created attachment 54137 [details] [review] Patch-2
Created attachment 54138 [details] [review] Patch-3
Created attachment 54139 [details] [review] Patch-4
Hi, Please review the four patches attached. Regards, Archana.
Also gnome-vfs-2.0-sections.txt file needs to add GnomeVFSURI to get it documented. Attaching below a patch for that.
Created attachment 54211 [details] [review] Patch to add GnomeVFSURI in gnome-vfs-2.0-sections.txt
I commited all the doc patches after some quick looks to make sure they seem ok. I didn't do any heavy reviewing, but its certainly better than it was before now. I'm leaving this bug open, allowing you to figure out if whats reported in this bug is now fixed.
Yes, this bug is now fixed.