Move a comment useful to the caller to the .h, rather than keeping it

in the .c

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15127

diff --git a/coregrind/m_libcprint.c b/coregrind/m_libcprint.c
index b6efaada53d3504e60b6a63604bf9216c26c4697..114467fb16c8c55b4f031a53f5d2945c34927541 100644 (file)
--- a/coregrind/m_libcprint.c
+++ b/coregrind/m_libcprint.c
@@ -647,9 +647,6 @@ void VG_(err_config_error) ( const HChar* format, ... )
    VG_(sr_as_string)()
    ------------------------------------------------------------------ */
 
-/* Return a textual representation of a SysRes value in a statically
-   allocated buffer. The buffer will be overwritten with the next 
-   invocation. */
 #if defined(VGO_linux)
 // FIXME: Does this function need to be adjusted for MIPS's _valEx ?
 const HChar *VG_(sr_as_string) ( SysRes sr )

diff --git a/include/pub_tool_libcprint.h b/include/pub_tool_libcprint.h
index 60e47531cb4519432443d2ac049130fb7787ab6e..5d38127403c002f983dc8daa4756d32b79216e5d 100644 (file)
--- a/include/pub_tool_libcprint.h
+++ b/include/pub_tool_libcprint.h
@@ -154,7 +154,9 @@ extern UInt VG_(dmsg)( const HChar* format, ... ) PRINTF_CHECK(1, 2);
 /* Flush any output cached by previous calls to VG_(message) et al. */
 extern void VG_(message_flush) ( void );
 
-/* Return a SysRes value as a character string. */
+/* Return a textual representation of a SysRes value in a statically
+   allocated buffer. The buffer will be overwritten with the next 
+   invocation. */
 extern const HChar *VG_(sr_as_string) ( SysRes sr );
 
 #endif   // __PUB_TOOL_LIBCPRINT_H