diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-11-21 11:13:15 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-11-21 11:15:24 +0100 |
commit | 2a86788765b1cfe61bbb54ee37b9915f32e9e490 (patch) | |
tree | 0031ed338e019f5a5324a9755308dcbbb0624de4 /rtemsspec | |
parent | 010b732a89352993eda688f2352375464fd712e3 (diff) |
membench: Clarify wording
Diffstat (limited to 'rtemsspec')
-rw-r--r-- | rtemsspec/membench.py | 13 | ||||
-rw-r--r-- | rtemsspec/tests/test_membench.py | 40 |
2 files changed, 46 insertions, 7 deletions
diff --git a/rtemsspec/membench.py b/rtemsspec/membench.py index b395f728..35ffef2f 100644 --- a/rtemsspec/membench.py +++ b/rtemsspec/membench.py @@ -382,9 +382,16 @@ def _generate_table(content: SphinxContent, sections_by_uid: SectionsByUID, pivot = items[0] section = f"Benchmarks Based on: {pivot.spec}" with content.section(section): - content.wrap(f"""The following memory benchmarks are based on the -memory benchmark defined by -{get_reference(_make_label(pivot), pivot.spec)}.""") + content.add(f"""The following static memory benchmarks are based on the +reference memory benchmark specified by +{get_reference(_make_label(pivot), pivot.spec)}. +The numbers of the first row represent the section sizes of the reference +memory benchmark program in bytes. The numbers in the following rows indicate +the change in bytes of the section sizes with respect to the reference memory +benchmark program of the first row. A ``+`` indicates a size increase and a +``-`` indicates a size decrease. This hints how the static memory usage +changes when the feature set changes with respect to the reference memory +benchmark.""") content.add_simple_table(rows) diff --git a/rtemsspec/tests/test_membench.py b/rtemsspec/tests/test_membench.py index 66ca8c7d..4a5c9bd8 100644 --- a/rtemsspec/tests/test_membench.py +++ b/rtemsspec/tests/test_membench.py @@ -77,8 +77,16 @@ def test_membench(tmpdir, monkeypatch): Benchmarks Based on: spec:/t0 ============================= -The following memory benchmarks are based on the memory benchmark defined by +The following static memory benchmarks are based on the +reference memory benchmark specified by :ref:`spec:/t0 <MembenchT0>`. +The numbers of the first row represent the section sizes of the reference +memory benchmark program in bytes. The numbers in the following rows indicate +the change in bytes of the section sizes with respect to the reference memory +benchmark program of the first row. A ``+`` indicates a size increase and a +``-`` indicates a size decrease. This hints how the static memory usage +changes when the feature set changes with respect to the reference memory +benchmark. .. table:: :class: longtable @@ -97,8 +105,16 @@ The following memory benchmarks are based on the memory benchmark defined by Benchmarks Based on: spec:/t0 ============================= -The following memory benchmarks are based on the memory benchmark defined by +The following static memory benchmarks are based on the +reference memory benchmark specified by :ref:`spec:/t0 <MembenchT0>`. +The numbers of the first row represent the section sizes of the reference +memory benchmark program in bytes. The numbers in the following rows indicate +the change in bytes of the section sizes with respect to the reference memory +benchmark program of the first row. A ``+`` indicates a size increase and a +``-`` indicates a size decrease. This hints how the static memory usage +changes when the feature set changes with respect to the reference memory +benchmark. .. table:: :class: longtable @@ -186,8 +202,16 @@ The Blue Green description. Benchmarks Based on: spec:/t0 ============================= -The following memory benchmarks are based on the memory benchmark defined by +The following static memory benchmarks are based on the +reference memory benchmark specified by :ref:`spec:/t0 <MembenchT0>`. +The numbers of the first row represent the section sizes of the reference +memory benchmark program in bytes. The numbers in the following rows indicate +the change in bytes of the section sizes with respect to the reference memory +benchmark program of the first row. A ``+`` indicates a size increase and a +``-`` indicates a size decrease. This hints how the static memory usage +changes when the feature set changes with respect to the reference memory +benchmark. .. table:: :class: longtable @@ -206,8 +230,16 @@ The following memory benchmarks are based on the memory benchmark defined by Benchmarks Based on: spec:/t0 ============================= -The following memory benchmarks are based on the memory benchmark defined by +The following static memory benchmarks are based on the +reference memory benchmark specified by :ref:`spec:/t0 <MembenchT0>`. +The numbers of the first row represent the section sizes of the reference +memory benchmark program in bytes. The numbers in the following rows indicate +the change in bytes of the section sizes with respect to the reference memory +benchmark program of the first row. A ``+`` indicates a size increase and a +``-`` indicates a size decrease. This hints how the static memory usage +changes when the feature set changes with respect to the reference memory +benchmark. .. table:: :class: longtable |