Skip to content

Commit

Permalink
Fixup misc. typos in sysman programming guides (#202)
Browse files Browse the repository at this point in the history
Signed-off-by: Will Damon <[email protected]>
  • Loading branch information
wdamon-intel authored Aug 28, 2023
1 parent 4b85dc4 commit 636da1d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions scripts/sysman/EXT_EngineActivity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Engine Activity

This extension provides capability to user to gather the activity stats for each Virtual Function (VF) associated with engine group.
Intended use case of the feature is to query utilization stats from Physical Function (PF) interface. However, the extension
may return error code $X_RESULT_ERROR_UNSUPPORTED_FEATURE if an environment does not support it.
may return error code ${X}_RESULT_ERROR_UNSUPPORTED_FEATURE if an environment does not support it.
If VF has no activity value to report, then implementation shall reflect that appropriately in ${s}_engine_stats_t struct so that percentage
calculation results in value of 0.
If PF has no activity value to report, then implementation shall reflect that appropriately in ${s}_engine_stats_t struct which is
Expand Down Expand Up @@ -75,4 +75,4 @@ The following pseudo-code demonstrates a sequence for obtaining the engine activ
for (uint32_t idx = 0; idx < engineStatCount; ++idx) {
double utilization = (engineStats1[idx].activeTime - engineStats0[idx].activeTime)/(engineStats1[idx].timestamp - engineStats0[idx].timestamp);
output("%s Utilization of engine type pertaining to this handle = %.2f\n", (idx == 0) ? "PF" : "VF", utilization);
}
}
6 changes: 3 additions & 3 deletions scripts/sysman/PROG.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<%

<%
OneApi=tags['$OneApi']
x=tags['$x']
X=x.upper()
Expand Down Expand Up @@ -1631,8 +1632,7 @@ the device and sub-devices:
else
output(" Config: DOWN")
${s}FabricPortGetMultiPortThroughput provides mechanism for user to gather throughput
values for multiple ports together in a single call.
The function ${s}FabricPortGetMultiPortThroughput provides a mechanism for the user to gather throughput values for multiple ports together in a single call.

The following pseudo-code describes how API is used to gather throughput:

Expand Down

0 comments on commit 636da1d

Please sign in to comment.