shlib-compat: Update documentation of the compat_symbol_reference macro

diff --git a/ChangeLog b/ChangeLog
index e45b749a40e8da0918d42b44cc6526b6bb031c9b..debac64d25adf09ef0a3e6f79eae3792ad9bcb38 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2017-10-16  Carlos O'Donell  <carlos@redhat.com>
+
+       * include/shlib-compat.h (compat_symbol_reference): Update
+       comment.
+
 2017-10-16  Joseph Myers  <joseph@codesourcery.com>
 
        * math/Makefile (test-types): Add

diff --git a/include/shlib-compat.h b/include/shlib-compat.h
index d872afcbab0a3f430e5e83aa260860bda9562cf6..6f11be804a1a499b8074a0e28dfede3dab67281d 100644 (file)
--- a/include/shlib-compat.h
+++ b/include/shlib-compat.h
@@ -78,8 +78,12 @@
 
 #endif
 
-/* Use compat_symbol_reference for a reference to a specific version
-   of a symbol.  Use compat_symbol to define such a symbol.  */
+/* Use compat_symbol_reference for a reference *or* definition of a
+   specific version of a symbol.  Definitions are primarily used to
+   ensure tests reference the exact compat symbol required, or define an
+   interposing symbol of the right version e.g. __malloc_initialize_hook
+   in mcheck-init.c.  Use compat_symbol to define such a symbol within
+   the shared libraries that are built for users.  */
 #define compat_symbol_reference(lib, local, symbol, version) \
   compat_symbol_reference_1 (lib, local, symbol, version)
 #define compat_symbol_reference_1(lib, local, symbol, version) \