Skip to content

Commit

Permalink
callstack: Fix the "i.e." abbreviation syntax used
Browse files Browse the repository at this point in the history
Change-Id: I8f92e4299bb5a7553d20c133d44d0079bbc1c416
Signed-off-by: Marco Miller <marco.miller@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass/org.eclipse.tracecompass/+/200928
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
  • Loading branch information
marco-miller committed Mar 31, 2023
1 parent 6484af7 commit c6c9f21
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 16 deletions.
Expand Up @@ -40,8 +40,8 @@
* Represents the actual callstack for one element. The callstack is a stack of
* calls, whether function calls, executions, sub-routines that have a certain
* depth and where durations at each depth is in the form of a reverse pyramid,
* ie, a call at level n+1 will have start_n+1 {@literal >=} start_n and end_n+1
* {@literal <=} end_n.
* i.e., a call at level n+1 will have start_n+1 {@literal >=} start_n and
* end_n+1 {@literal <=} end_n.
*
* TODO: Is that true? the reverse pyramid?
*
Expand Down
Expand Up @@ -95,7 +95,7 @@ public interface ICallStackElement extends ITree {
* Get whether this element is a leaf element in the callstack hierarchy.
* Leaf elements are expected to contain the proper analysis data.
*
* @return Whether this element is a leaf, i.e. contains analysis data or
* @return Whether this element is a leaf, i.e., contains analysis data or
* not
*/
boolean isLeaf();
Expand Down
Expand Up @@ -25,7 +25,7 @@
import com.google.common.collect.Multimap;

/**
* Represents a callgraph, ie the aggregation of callsites per elements.
* Represents a callgraph, i.e., the aggregation of callsites per elements.
*
* TODO: Have an interface and keep the add* method internal
*
Expand Down
Expand Up @@ -49,7 +49,7 @@ public interface ICalledFunction extends INamedSegment {
/**
* The segment's time on CPU
*
* @return The CPU time, ie the time spent on the CPU by the thread who
* @return The CPU time, i.e., the time spent on the CPU by the thread who
* called this function. {@link IHostModel#TIME_UNKNOWN} if not
* available.
*/
Expand Down
Expand Up @@ -31,7 +31,7 @@ public class CallStackGroupDescriptor implements ICallStackGroupDescriptor {
* @param name
* The name of this group
* @param nextGroup
* The next group of the hierarchy, ie the child of the group
* The next group of the hierarchy, i.e., the child of the group
* being constructed or <code>null</code> if this group is the
* leaf
* @param isSymbolKeyGroup
Expand Down
Expand Up @@ -95,7 +95,7 @@

/**
* This class provides the data from an instrumented callstack analysis, in the
* form of a flamechart, ie the groups are returned hierarchically and leaf
* form of a flamechart, i.e., the groups are returned hierarchically and leaf
* groups return their callstacks.
*
* @author Geneviève Bastien
Expand Down
Expand Up @@ -35,7 +35,7 @@ public class InstrumentedGroupDescriptor extends CallStackGroupDescriptor {
* @param subPath
* The sub-path to this group
* @param nextGroup
* The next group of the hierarchy, ie the child of the group
* The next group of the hierarchy, i.e., the child of the group
* being constructed or <code>null</code> if this group is the
* leaf
* @param isSymbolKeyGroup
Expand Down
Expand Up @@ -157,7 +157,7 @@ default int getThreadOnCpu(int cpu, long t) {
* @param end
* The end of the period for which to get the time on CPU
* @param resolution
* The resolution, ie the number of nanoseconds between kernel
* The resolution, i.e., the number of nanoseconds between kernel
* status queries. A value lower or equal to 1 will return all
* intervals.
* @return An iterator over the status intervals for the thread
Expand Down
Expand Up @@ -16,8 +16,8 @@
import org.eclipse.jdt.annotation.Nullable;

/**
* A basic interface for a tree structure, ie hierarchical data where each node
* can be linked to a specific object.
* A basic interface for a tree structure, i.e., hierarchical data where each
* node can be linked to a specific object.
*
* @author Geneviève Bastien
*/
Expand Down
Expand Up @@ -209,7 +209,7 @@ public boolean hasStatistics() {

/**
* Get a weighted tree set for a time selection. It should be a subset of
* the complete tree, ie the elements, and weights of the weighted trees
* the complete tree, i.e., the elements and weights of the weighted trees
* should be included in full tree, but its range should cover only the
* requested time range. If this provider does not support selection range,
* <code>null</code> should be returned.
Expand Down
Expand Up @@ -193,7 +193,7 @@ public class FlameGraphView extends TmfView {
*/
private final Semaphore fLock = new Semaphore(1);

// Variable used to specify when the graph is dirty, ie waiting for data
// Variable used to specify when the graph is dirty, i.e., waiting for data
// refresh
private final AtomicInteger fDirty = new AtomicInteger();

Expand Down
Expand Up @@ -23,7 +23,8 @@
* Represents the actual callstack for one element. The callstack is a stack of
* calls, whether function calls, executions, sub-routines that have a certain
* depth and where durations at each depth is in the form of a reverse pyramid,
* ie, a call at level n+1 will have start_n+1 >= start_n and end_n+1 <= end_n.
* i.e., a call at level n+1 will have start_n+1 >= start_n and end_n+1 <=
* end_n.
*
* TODO: Is that true? the reverse pyramid?
*
Expand Down
Expand Up @@ -36,8 +36,9 @@ public class InstrumentedGroupDescriptor extends ProfilingGroupDescriptor {
* @param subPath
* The sub-path to this group
* @param nextGroup
* The next group of the hierarchy, ie the child of the group being
* constructed or <code>null</code> if this group is the leaf
* The next group of the hierarchy, i.e., the child of the group
* being constructed or <code>null</code> if this group is the
* leaf
* @param isSymbolKeyGroup
* Whether this level contains the symbol key
*/
Expand Down

0 comments on commit c6c9f21

Please sign in to comment.