Skip to content

Commit 32c07a2

Browse files
amx-piapjamoralp
andauthored
Apply suggestions from code review
Co-authored-by: Jose Antonio Moral <joseantoniomoralparras@gmail.com>
1 parent 0ed7e6f commit 32c07a2

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

  • _docs/concepts/benchmarking/benchmarking

_docs/concepts/benchmarking/benchmarking/index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,21 @@ permalink: /docs/concepts/benchmarking/benchmarking/
2121

2222
## Introduction to Benchmarking
2323

24-
Developing working and stable application from the scribbles to the final
25-
executing binary is long and hard tasks. During this process developers may come
26-
across stabilities issues, perfomances issues. In addition to these issues, some
24+
Developing a working and stable application, from the scribbles to the final
25+
executing binary, is a long and hard task. During this process, developers may come
26+
across stability and perfomance issues. In addition to these issues, some
2727
specified QoS might be difficult to quantify. Solving those problems without the
2828
proper tools might be frustrating, tedious tasks leading to reduce developers
2929
efficiency. An adapted benchmarking tool could overcome all those development
3030
obstacles and increase development time. There are different KPI (Keep
3131
Performance Indicators) that one might be interested into. In the framework of
32-
this micro-ROS, the KPI can be freely chosen by the developer. In this way, the
32+
micro-ROS, the KPI can be freely chosen by the developer. In this way, the
3333
benchmarking tool will remain flexible and allow the community to constantly add
34-
some support for a lot of different KPI.
34+
support for a lot of different KPI.
3535

3636
The problems we want to tackle are:
3737

38-
* Out there, many benchmarking tools exist. Each of targeting different KPIs.
38+
* Out there, many benchmarking tools exist, each of them targeting different KPIs.
3939
* Different platforms (Linux/Nuttx/Baremetal et.c.).
4040
* Too few time/resources to code benchmarking tool for each.
4141
* Avoid code overhead: Keep code clarity.
@@ -69,14 +69,14 @@ platform. Every plugin will provide information as requested by the parser:
6969

7070
* Provide a list of supported platforms.
7171
* Provide a list of functions that are handled.
72-
* Provide snippets codes that will be added for benchmarking.
72+
* Provide snippet codes that will be added for benchmarking.
7373
* Provide a list of patches and/or patch code
7474
* Optional provide an end script to run and execute the benchmarks
7575

7676

7777
## Shadow Builder
7878

79-
This section will introduce some concept related to the shadow builder (SB).
79+
This section will introduce some concepts related to the shadow builder (SB).
8080

8181
The Shadow builder is a tool that will transparently instrument the code to
8282
benchmark. The tools will be able to output an “instrumented code” that will be
@@ -92,12 +92,11 @@ builder process flow:
9292
target binary benchmarking.
9393

9494
The SB (Shadow Builder) is meant to be as transparent as possible for the user.
95-
And if the benchmarking is not activated, it should be bypassed. Get
96-
appropriate sources
95+
And if the benchmarking is not activated, it should be bypassed.
9796

9897
The SB is in charge of getting the path/git repository to the source code that
9998
needs to be benchmarking. The benchmarking. The sources are specified by the
100-
user in the benchmarking configuration file. Injecting code
99+
user in the benchmarking configuration file.
101100

102101
In order to inject code, there are some tools that allow this. CLang AST tool
103102
will allow to inject some code.

0 commit comments

Comments
 (0)