diff options
| author | Tor Lillqvist <tml@novell.com> | 2007-06-11 08:02:03 +0000 |
|---|---|---|
| committer | Tor Lillqvist <tml@src.gnome.org> | 2007-06-11 08:02:03 +0000 |
| commit | 5acfdc7ca2c532d2c9dcc7742eb502eb1b56cd8e (patch) | |
| tree | 6443bec9db1df6f52b3603e50aff19a43bfc0ad9 | |
| parent | 7cbbe5657ae1fc564e5ec8d583872d0e702c0b4a (diff) | |
| download | glib-5acfdc7ca2c532d2c9dcc7742eb502eb1b56cd8e.tar.gz | |
Update doc comments. Mention that it is not recommeded to use the Registry
2007-06-11 Tor Lillqvist <tml@novell.com>
* glib/gwin32.c (g_win32_get_package_installation_directory)
(g_win32_get_package_installation_subdirectory): Update doc
comments. Mention that it is not recommeded to use the Registry
features.
svn path=/branches/glib-2-12/; revision=5548
| -rw-r--r-- | ChangeLog | 7 | ||||
| -rw-r--r-- | glib/gwin32.c | 23 |
2 files changed, 25 insertions, 5 deletions
@@ -1,3 +1,10 @@ +2007-06-11 Tor Lillqvist <tml@novell.com> + + * glib/gwin32.c (g_win32_get_package_installation_directory) + (g_win32_get_package_installation_subdirectory): Update doc + comments. Mention that it is not recommeded to use the Registry + features. + 2007-05-25 Behdad Esfahbod <behdad@gnome.org> * glib/guniprop.c (g_unichar_iswide), (g_unichar_iswide_cjk): diff --git a/glib/gwin32.c b/glib/gwin32.c index 4589557ca..5b7263a7c 100644 --- a/glib/gwin32.c +++ b/glib/gwin32.c @@ -323,16 +323,26 @@ get_package_directory_from_module (gchar *module_name) * @dll_name: The name of a DLL that a package provides, or %NULL, in UTF-8 * * Try to determine the installation directory for a software package. - * Typically used by GNU software packages. * * @package should be a short identifier for the package. Typically it * is the same identifier as used for - * <literal>GETTEXT_PACKAGE</literal> in software configured according - * to GNU standards. The function first looks in the Windows Registry - * for the value <literal>#InstallationDirectory</literal> in the key + * <literal>GETTEXT_PACKAGE</literal> in software configured using GNU + * autotools. The function first looks in the Windows Registry for the + * value <literal>#InstallationDirectory</literal> in the key * <literal>#HKLM\Software\@package</literal>, and if that value * exists and is a string, returns that. * + * It is strongly recommended that packagers of GLib-using libraries + * for Windows do not store installation paths in the Registry to be + * used by this function as that interfers with having several + * parallel installations of the library. Parallel installations of + * different versions of some GLib-using library, or GLib itself, + * might well be desirable for various reasons. + * + * For the same reason it is recommeded to always pass %NULL as + * @package to this function, to avoid the temptation to use the + * Registry. + * * 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 * into the current process. Typically that would be the name of the @@ -492,7 +502,10 @@ g_win32_get_package_installation_directory (gchar *package, * Returns a newly-allocated string containing the path of the * subdirectory @subdir in the return value from calling * g_win32_get_package_installation_directory() with the @package and - * @dll_name parameters. + * @dll_name parameters. See the documentation for + * g_win32_get_package_installation_directory() for more details. In + * particular, note that it is recomended to always pass NULL as + * @package. * * Returns: a string containing the complete path to @subdir inside * the installation directory of @package. The returned string is in |