From 49e1617b2cfb4948c02aea897a0e09dcc0a2a05a Mon Sep 17 00:00:00 2001 From: Geoffrey Blake Date: Tue, 6 Nov 2018 09:01:46 -0600 Subject: [PATCH] docs: Add in software dependencies to README.rst Add in required software dependencies for the lockhammer workload as raised in Issue #44. Signed-off-by: Geoffrey Blake (Geoffrey.Blake@arm.com) --- benchmarks/lockhammer/README.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/benchmarks/lockhammer/README.rst b/benchmarks/lockhammer/README.rst index 8dc30c1..f9bb2f6 100644 --- a/benchmarks/lockhammer/README.rst +++ b/benchmarks/lockhammer/README.rst @@ -38,13 +38,23 @@ as possible). Detailed information about each run is printed to stderr while a CSV summary is printed to stdout. +Software Dependencies +--------------------- + ++ gcc ++ python3 ++ sh python3 module ++ yaml python3 module + Usage ===== The build system will generate a separate lockhammer binary for each test with the format lh_[testname]. Each lockhammer binary accepts the following options: - [-t threads] Number of threads to exercise, default online cores - [-a acquires] Number of acquisitions per thread, default 50000 - [-c critical] Critical section in loop iterations, default 0 - [-p parallel] Parallelizable section in loop iterations, default 0 - [-s] Run in safe mode, default no +:: + [-t threads] Number of threads to exercise, default online cores + [-a acquires] Number of acquisitions per thread, default 50000 + [-c critical] Critical section in loop iterations, default 0 + [-p parallel] Parallelizable section in loop iterations, default 0 + [-s] Run in safe mode with normal priority threads instead of RT_FIFO priority, default no +