Skip to content

Commit ca914df

Browse files
committed
Clarify uncached threshold javadocs
1 parent a0288cc commit ca914df

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

truffle/src/com.oracle.truffle.api.bytecode/src/com/oracle/truffle/api/bytecode/BytecodeNode.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -976,10 +976,10 @@ protected void setLocalValueInternalDouble(Frame frame, int localOffset, int loc
976976
public abstract List<LocalVariable> getLocals();
977977

978978
/**
979-
* Sets the number of times the uncached interpreter must be invoked/resumed or branch backwards
980-
* before transitioning to cached. See {@link GenerateBytecode#defaultUncachedThreshold} for
981-
* information about the default threshold and the meaning of different {@code threshold}
982-
* values.
979+
* Sets the number of invocations/resumptions or backward branches for which this interpreter
980+
* executes uncached before transitioning to cached on the next such event. See
981+
* {@link GenerateBytecode#defaultUncachedThreshold} for information about the default threshold
982+
* and the meaning of different {@code threshold} values.
983983
* <p>
984984
* This method should be called before executing the root node. It will not have any effect on
985985
* an uncached interpreter that is currently executing, an interpreter that is already cached,

truffle/src/com.oracle.truffle.api.bytecode/src/com/oracle/truffle/api/bytecode/GenerateBytecode.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@
129129
boolean enableUncachedInterpreter() default false;
130130

131131
/**
132-
* Sets the default number of times an uncached interpreter must be invoked/resumed or branch
133-
* backwards before transitioning to cached.
132+
* Sets the default number of invocations/resumptions or backward branches for which the
133+
* interpreter executes uncached before transitioning to cached on the next such event.
134134
* <p>
135135
* The default uncached threshold expression supports a subset of Java (see the
136136
* {@link com.oracle.truffle.api.dsl.Cached Cached} documentation). It should evaluate to an
137137
* int. It should be a positive value, {@code 0}, or {@code Integer.MIN_VALUE}. A threshold of
138-
* {@code 0} will cause each bytecode node to immediately transition to cached on first
139-
* invocation. A threshold of {@code Integer.MIN_VALUE} forces a bytecode node to stay uncached
140-
* (i.e., it will not transition to cached).
138+
* {@code 0} will cause each bytecode node to immediately transition to cached on the first
139+
* invocation/resume. A threshold of {@code Integer.MIN_VALUE} forces a bytecode node to stay
140+
* uncached (i.e., it will not transition to cached).
141141
* <p>
142142
* The default local value expression can be a constant literal (e.g., {@code "42"}), in which
143143
* case the value will be validated at build time. However, the expression can also refer to

0 commit comments

Comments
 (0)