embench / embench-iot

The main Embench repository
https://www.embench.org/
GNU General Public License v3.0
259 stars 105 forks source link

User guide enhancement suggestion #84

Open Roger-Shepherd opened 4 years ago

Roger-Shepherd commented 4 years ago

I was caught out by the naming convention for Python modules. For a speed benchmark the documentation says:

--target-module : This mandatory argument specifies a python module in the pylib directory with definitions of routines to run the benchmark.

I naïvely assumed that "specifies" meant the name of the python file (i.e. xyz.py), it doesn't it means the name of the module (i.e. xyzzy). The documentation might make this explicit for those unfamiliar with Python conventions.

jeremybennett commented 4 years ago

Good point. Would you like to submit a patch to make this clear. Thanks, Jeremy

Roger-Shepherd commented 4 years ago

Done as pull request.