Skip to content

Commit 636da1d

Browse files
authored
Fixup misc. typos in sysman programming guides (#202)
Signed-off-by: Will Damon <[email protected]>
1 parent 4b85dc4 commit 636da1d

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

scripts/sysman/EXT_EngineActivity.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Engine Activity
3232

3333
This extension provides capability to user to gather the activity stats for each Virtual Function (VF) associated with engine group.
3434
Intended use case of the feature is to query utilization stats from Physical Function (PF) interface. However, the extension
35-
may return error code $X_RESULT_ERROR_UNSUPPORTED_FEATURE if an environment does not support it.
35+
may return error code ${X}_RESULT_ERROR_UNSUPPORTED_FEATURE if an environment does not support it.
3636
If VF has no activity value to report, then implementation shall reflect that appropriately in ${s}_engine_stats_t struct so that percentage
3737
calculation results in value of 0.
3838
If PF has no activity value to report, then implementation shall reflect that appropriately in ${s}_engine_stats_t struct which is
@@ -75,4 +75,4 @@ The following pseudo-code demonstrates a sequence for obtaining the engine activ
7575
for (uint32_t idx = 0; idx < engineStatCount; ++idx) {
7676
double utilization = (engineStats1[idx].activeTime - engineStats0[idx].activeTime)/(engineStats1[idx].timestamp - engineStats0[idx].timestamp);
7777
output("%s Utilization of engine type pertaining to this handle = %.2f\n", (idx == 0) ? "PF" : "VF", utilization);
78-
}
78+
}

scripts/sysman/PROG.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<%
1+
2+
<%
23
OneApi=tags['$OneApi']
34
x=tags['$x']
45
X=x.upper()
@@ -1631,8 +1632,7 @@ the device and sub-devices:
16311632
else
16321633
output(" Config: DOWN")
16331634
1634-
${s}FabricPortGetMultiPortThroughput provides mechanism for user to gather throughput
1635-
values for multiple ports together in a single call.
1635+
The function ${s}FabricPortGetMultiPortThroughput provides a mechanism for the user to gather throughput values for multiple ports together in a single call.
16361636

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

0 commit comments

Comments
 (0)