1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-20 20:09:11 +00:00

Merge pull request #455 from marcbonnici/documentation

Documentation fixes
This commit is contained in:
setrofim 2017-08-04 16:20:35 +01:00 committed by GitHub
commit dd8843d24a
2 changed files with 9 additions and 7 deletions

View File

@ -43,6 +43,7 @@ class AppShare(AndroidUxPerfWorkload):
screen UI is dependent on an existing connection.
Test description:
1. GooglePhotos is started in offline access mode
1.1. The welcome screen is dismissed
1.2. Any promotion popup is dismissed

View File

@ -40,7 +40,7 @@ class RtApp(Workload):
name = 'rt-app'
description = """
A test application that simulates cofigurable real-time periodic load.
A test application that simulates configurable real-time periodic load.
rt-app is a test application that starts multiple periodic threads in order to
simulate a real-time periodic load. It supports SCHED_OTHER, SCHED_FIFO,
@ -99,7 +99,8 @@ class RtApp(Workload):
}
}
Please refer to the exising configs in ``%s`` for more examples.
Please refer to the existing configs in ``$WA_ROOT/wlauto/workloads/rt_app/use_case``
for more examples.
The version of rt-app currently used with this workload contains enhancements and
modifications done by Linaro. The source code for this version may be obtained here:
@ -110,25 +111,25 @@ class RtApp(Workload):
https://github.com/scheduler-tools/rt-app
""" % PACKAGED_USE_CASE_DIRECTORY
"""
parameters = [
Parameter('config', kind=str, default='taskset',
description='''
Use case configuration file to run with rt-app. This may be
either the name of one of the "standard" configuratons included
either the name of one of the "standard" configurations included
with the workload. or a path to a custom JSON file provided by
the user. Either way, the ".json" extension is implied and will
be added automatically if not specified in the argument.
The following is th list of standard configuraionts currently
The following is the list of standard configurations currently
included with the workload: {}
'''.format(', '.join(os.listdir(PACKAGED_USE_CASE_DIRECTORY)))),
Parameter('duration', kind=int,
description='''
Duration of the workload execution in Seconds. If specified, this
will override the corresponing parameter in the JSON config.
will override the corresponding parameter in the JSON config.
'''),
Parameter('taskset_mask', kind=int,
description='Constrain execution to specific CPUs.'),
@ -140,7 +141,7 @@ class RtApp(Workload):
Parameter('force_install', kind=bool, default=False,
description="""
If set to ``True``, rt-app binary will always be deployed to the
target device at the begining of the run, regardless of whether it
target device at the beginning of the run, regardless of whether it
was already installed there.
"""),
]