luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-25 03:32:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc change: Deprecate passing anything but NULL for the "package"

Browse Source 
2008-02-13  Tor Lillqvist  <tml@novell.com>

	* glib/gwin32.c: Doc change: Deprecate passing anything but NULL
	for the "package" parameter to
	g_win32_get_package_installation_directory() and
	g_win32_get_package_installation_subdirectory().


svn path=/trunk/; revision=6508
This commit is contained in:
Tor Lillqvist 2008-02-13 11:59:14 +00:00 committed by Tor Lillqvist
parent d760d3e22d
commit 81e37c3d41
2 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@ -1,3 +1,10 @@
2008-02-13 Tor Lillqvist <tml@novell.com>
* glib/gwin32.c: Doc change: Deprecate passing anything but NULL
for the "package" parameter to
g_win32_get_package_installation_directory() and
g_win32_get_package_installation_subdirectory().
2008-02-11 Matthias Clasen <mclasen@redhat.com> 2008-02-11 Matthias Clasen <mclasen@redhat.com>
* configure.in: Bump version * configure.in: Bump version

29
glib/gwin32.c
View File

@ -270,13 +270,15 @@ get_package_directory_from_module (const gchar *module_name)
/** /**
* g_win32_get_package_installation_directory: * g_win32_get_package_installation_directory:
* @package: An identifier for a software package, or %NULL, in UTF-8 * @package: You should pass %NULL for this.
* @dll_name: The name of a DLL that a package provides, or %NULL, in UTF-8 * @dll_name: The name of a DLL that a package provides in UTF-8, or %NULL.
* *
* Try to determine the installation directory for a software package. * Try to determine the installation directory for a software package.
* *
* @package should be a short identifier for the package. Typically it * The use of @package is deprecated. You should always pass %NULL.
* is the same identifier as used for *
* Its original intended use was for a short identifier for
* the package, typically the same identifier as used for
* <literal>GETTEXT_PACKAGE</literal> in software configured using GNU * <literal>GETTEXT_PACKAGE</literal> in software configured using GNU
* autotools. The function first looks in the Windows Registry for the * autotools. The function first looks in the Windows Registry for the
* value <literal>&num;InstallationDirectory</literal> in the key * value <literal>&num;InstallationDirectory</literal> in the key
@ -286,13 +288,14 @@ get_package_directory_from_module (const gchar *module_name)
* It is strongly recommended that packagers of GLib-using libraries * It is strongly recommended that packagers of GLib-using libraries
* for Windows do not store installation paths in the Registry to be * for Windows do not store installation paths in the Registry to be
* used by this function as that interfers with having several * used by this function as that interfers with having several
* parallel installations of the library. Parallel installations of * parallel installations of the library. Enabling multiple
* different versions of some GLib-using library, or GLib itself, * installations of different versions of some GLib-using library, or
* might well be desirable for various reasons. * GLib itself, is desirable for various reasons.
* *
* For the same reason it is recommeded to always pass %NULL as * For this reason it is recommeded to always pass %NULL as
* @package to this function, to avoid the temptation to use the * @package to this function, to avoid the temptation to use the
* Registry. * Registry. In version 2.18 of GLib the @package parameter
* will be ignored and this function won't look in the Registry at all.
* *
* If @package is %NULL, or the above value isn't found in the * If @package is %NULL, or the above value isn't found in the
* Registry, but @dll_name is non-%NULL, it should name a DLL loaded * Registry, but @dll_name is non-%NULL, it should name a DLL loaded
@ -422,8 +425,8 @@ g_win32_get_package_installation_directory (const gchar *package,
/** /**
* g_win32_get_package_installation_subdirectory: * g_win32_get_package_installation_subdirectory:
* @package: An identifier for a software package, in UTF-8, or %NULL * @package: You should pass %NULL for this.
* @dll_name: The name of a DLL that a package provides, in UTF-8, or %NULL * @dll_name: The name of a DLL that a package provides, in UTF-8, or %NULL.
* @subdir: A subdirectory of the package installation directory, also in UTF-8 * @subdir: A subdirectory of the package installation directory, also in UTF-8
* *
* Returns a newly-allocated string containing the path of the * Returns a newly-allocated string containing the path of the
@ -431,8 +434,8 @@ g_win32_get_package_installation_directory (const gchar *package,
* g_win32_get_package_installation_directory() with the @package and * g_win32_get_package_installation_directory() with the @package and
* @dll_name parameters. See the documentation for * @dll_name parameters. See the documentation for
* g_win32_get_package_installation_directory() for more details. In * g_win32_get_package_installation_directory() for more details. In
* particular, note that it is recomended to always pass NULL as * particular, note that it is deprecated to pass anything except NULL
* @package. * as @package.
* *
* Returns: a string containing the complete path to @subdir inside * Returns: a string containing the complete path to @subdir inside
* the installation directory of @package. The returned string is in * the installation directory of @package. The returned string is in