GNOME Bugzilla – Bug 351587
API documentation issues with 2.15 release
Last modified: 2008-09-06 19:12:07 UTC
To follow API/ABI release team rules, API changes should be documented with Since tags: http://live.gnome.org/ReleasePlanning/ModuleRequirements/Platform These new symbols are exposed in the library and the header files, and should be documented with Since tags. Note that get_type functions are normally not documented: gnome_vfs_drive_needs_eject gnome_vfs_module_callback_authentication_auth_type_get_type These new symbols are exposed in the library but not the header file. Should they be hidden or static? Private exposed functions normally end in the "_private" prefix. gnome_vfs_daemon_message_append_file_info gnome_vfs_daemon_message_iter_append_file_info gnome_vfs_daemon_message_iter_get_file_info gnome_vfs_daemon_set_current_connection gnome_vfs_drive_to_dbus gnome_vfs_resolve_symlink gnome_vfs_volume_to_dbus
Also, I notice that the gnome-vfs-mime* functions that were moved to libbonobo haven't had their API documentation updated. Shouldn't the documentation for the affected functions mention something about the fact that they are now in the bonobo-activation library and users should link directly against this library to get the functions. Otherwise it would be confusing, I think, for users reading this documentation to know why their link command fails when they just link gnome-vfs library. gnome_vfs_mime_component_list_free gnome_vfs_mime_get_all_components gnome_vfs_mime_get_default_component gnome_vfs_mime_get_short_list_components gnome_vfs_mime_id_in_component_list gnome_vfs_mime_id_list_from_component_list gnome_vfs_mime_remove_component_from_list Also might be worth documenting that the bonobo_activation functions are preferred, and these are perhaps deprecated? bonobo_activation_get_all_components_for_mime_type bonobo_activation_get_default_component_for_mime_type
Lowering severity since this is clearly not a blocker. At least it hasn't stopped the last few releases :-)
gnome-vfs has been deprecated and superseded by gio/gvfs since GNOME 2.22, hence mass-closing many of the gnome-vfs requests/bug reports. This means that gnome-vfs is NOT actively maintained anymore, however patches are still welcome. If your reported issue is still valid for gio/gvfs, please feel free to file a bug report against glib/gio or gvfs. @Bugzilla mail recipients: query for gnome-vfs-mass-close to get rid of these notification emails all together. General further information: http://en.wikipedia.org/wiki/GVFS Reasons behind this decision are listed at http://www.mail-archive.com/gnome-vfs-list@gnome.org/msg00899.html