about summary refs log tree commit diff
path: root/include
diff options
context:
space:
mode:
authorCarlos O'Donell <carlos@redhat.com>2017-10-16 20:43:28 +0200
committerFlorian Weimer <fweimer@redhat.com>2017-10-16 20:43:28 +0200
commit3480ddc40b8f9a9fb277fe1883e359db3db0ab17 (patch)
tree1eae85677e5e15d911a800764a8e716528c2659e /include
parent596f70134a8f11967c65c1d55a94a3a2718c731d (diff)
downloadglibc-3480ddc40b8f9a9fb277fe1883e359db3db0ab17.tar.gz
glibc-3480ddc40b8f9a9fb277fe1883e359db3db0ab17.tar.xz
glibc-3480ddc40b8f9a9fb277fe1883e359db3db0ab17.zip
shlib-compat: Update documentation of the compat_symbol_reference macro
Diffstat (limited to 'include')
-rw-r--r--include/shlib-compat.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/shlib-compat.h b/include/shlib-compat.h
index d872afcbab..6f11be804a 100644
--- 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) \