changeset 14634:2496f9f49f6b

improved javadoc for Debug.logv() to explain why it should be avoided
author Doug Simon <doug.simon@oracle.com>
date Thu, 20 Mar 2014 12:36:53 +0100
parents da2431cc1506
children 186e57fa5eaa
files graal/com.oracle.graal.debug/src/com/oracle/graal/debug/Debug.java
diffstat 1 files changed, 3 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.debug/src/com/oracle/graal/debug/Debug.java	Thu Mar 20 11:48:39 2014 +0100
+++ b/graal/com.oracle.graal.debug/src/com/oracle/graal/debug/Debug.java	Thu Mar 20 12:36:53 2014 +0100
@@ -356,7 +356,9 @@
 
     /**
      * Prints a message to the current debug scope's logging stream. This method must only be called
-     * if debugging is {@linkplain Debug#isEnabled() enabled}.
+     * if debugging is {@linkplain Debug#isEnabled() enabled} as it incurs allocation at the call
+     * site. If possible, call one of the other {@code log()} methods in this class that take a
+     * fixed number of parameters.
      * 
      * @param format a format string
      * @param args the arguments referenced by the format specifiers in {@code format}