1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-06-16 21:36:08 +01:00
Commit Graph

61 Commits

Author SHA1 Message Date
700989298c doc: Correct ID names 2018-05-21 10:26:28 +01:00
69462e54a1 doc: Update APK workload parameter descriptions.
Clarify parameter descriptions.
2018-05-21 10:26:28 +01:00
5c6cc87105 doc: Update sections example.
Modify documention and example to better explain sections
2018-05-21 10:26:28 +01:00
b7c70aabae doc: Remove run_config directory`
Remove auto generated run_config directory, add to .gitignore and clear
on `make clean`
2018-05-21 10:26:28 +01:00
52b2df427e doc/show_cmd: Reword description and add settings option 2018-05-21 10:26:28 +01:00
9986423365 doc: Add documentation for the process command 2018-05-21 10:26:28 +01:00
192bebbc23 doc: update and extend Output docs
- Move output processing API docs into developer reference.
- Add a section on output directory structure to user reference.
- Rewrite the output section of the user guide to provide a very
  brief overview of the output directory and to link to the two
  sections above.
2018-05-18 17:52:49 +01:00
050722ee8f doc: user_guide: add a note about show command
Add a note describing the usage of "wa show"
2018-05-18 16:50:48 +01:00
b1b2131b0c doc: fix build warnings 2018-05-18 10:32:08 +01:00
d0368cf176 doc: re-write augmentations docs
Rewrite the "Output processors and Instruments" section into
"Augmentations" section.
2018-05-14 17:08:14 +01:00
c6fae6fa55 doc: update how-tos' titles
Update agenda and revent how-tos' titles to be more informative.
2018-05-14 17:08:14 +01:00
ee7734efd7 doc: agenda: add note about plugin names
Add a note explaining how plugin names are treated, and which names are
considered to be identical.
2018-05-14 17:08:14 +01:00
06b64de1be doc: user guide: fix result --> output
Fix an old reference to "result processors", correcting it to "output
processors".
2018-05-14 17:08:14 +01:00
66fa8c856a doc: Fix code highlighting 2018-05-14 16:34:10 +01:00
2a66e40d9b doc/config: Do not generate API documentation
On the latest version of Sphinx the way we were doing API generation
caused issues. Due to the structure/formatting of our code base the
output was not very useful anyway so remove the automatic generation
with the aim to manually document the relevant API in the future.
2018-05-14 16:34:10 +01:00
087c18c752 doc/migration_guide: Add references to confvalues 2018-05-11 18:06:24 +01:00
19184ceaf6 doc: Update reference and fix typos 2018-05-11 18:06:24 +01:00
86cc449203 doc: Improve description of context methods 2018-05-11 18:06:24 +01:00
48a7ad9415 doc/output: Update output directory information 2018-05-11 18:06:24 +01:00
9d0127d685 doc/installation: Fix formatting 2018-05-11 18:06:24 +01:00
1e750c659b utils/log: add early record buffering
Buffer early log records until a log file becomes available, flush
records to said file afterwards. This ensures that early log output,
which, among other things, contains plugin discovery logging, is not
lost. Buffer capacity is configurable via an environment variable.
2018-05-09 15:06:31 +01:00
98e86efbda doc: Fix references 2018-04-30 09:14:22 +01:00
7cb11f66cf doc: add building of instrument method map 2018-04-30 09:14:22 +01:00
9741014b35 doc: Fix formatting errors 2018-04-30 09:14:22 +01:00
0fd095622c doc: Improve installing executables documentation 2018-04-30 09:14:22 +01:00
1f9a233214 doc/agenda: Add documentation about classifiers 2018-04-30 09:14:22 +01:00
c1171263f9 doc/faq: Add solution to "Unknown runtime parameter" 2018-04-30 09:14:22 +01:00
504703d444 doc/migration_guide: Fix typo 2018-04-30 09:14:22 +01:00
61a9c96a7d doc/device_setup: Add examples of installing modules to target 2018-04-30 09:14:22 +01:00
f60b7eca16 doc/output_api: Improve examples 2018-04-30 09:14:22 +01:00
8c9c1a8f1e docs/user_guide: Clarify basic run command information. 2018-04-30 09:14:22 +01:00
81c6da9c2c Documentation: Add support for generating common target api 2018-04-30 09:14:22 +01:00
bc87eacde2 Documentation: Update WA3 Documentation
Update the documentation and build system for producing documentation for
WA3 with support for automatic building on readthedocs.

Note: This is currently a WIP.
2018-04-24 09:59:57 +01:00
60fbd17fab doc/revent: add missing verbatim block markup 2018-02-22 08:41:04 +00:00
87667cd161 doc/revent: fix event field descriptions
Fix the field descriptions for replay event to reflect the correct
signedness and size.

(note: the layout diagrams were already correct, just the textual
descriptions needed to be adjusted)
2018-02-22 08:41:04 +00:00
7cdb32c7f8 doc: update revent documentation
Forward-port the updated revent documentation from WA2, including
recording format description.
2017-09-27 10:34:48 +01:00
0c40cdae18 tools/revent: improve recording + add prebuilts
The begining and end of recording timestamps are now stored as part of
the recording. This allows to correctly replay recordings where the
first event occurs some time after the recording started, or the last
event some time before recording ended.

Add pre-built revent binaries for the armeabi and arm64 architectures.
2017-09-27 10:34:00 +01:00
c51593a729 pluginloader: Updated documentation to say plugin instead of extension 2016-09-27 11:17:25 +01:00
2ae8c6073f doc: Apply it's/its grammar pedantry 2016-01-25 13:34:24 +00:00
1e6eaff702 revent: Added record and replay commands
Added two commands to WA to record and replay input events using revent.

As part of this also added the ability to get a device model from
android and linux device. This may need to be improved in the future.
2016-01-22 10:40:03 +00:00
67213d471b BaseLinuxDevice: documentation update
Added docs explaining how extension developers should deploy binaries.
2016-01-19 10:45:09 +00:00
b04d141680 doc: updating installation instructions
Re-writing some of the instructions for clarity plus updating with the
correct pip invocations.
2015-11-23 15:47:27 +00:00
016876e814 Updated change log
Initial update of change log, this will probably need a lot of tidy up.
2015-11-23 10:11:23 +00:00
6e447aa8b2 docs: typo 2015-09-07 17:55:42 +01:00
47b2081ccb doc: fixing daq wiring screenshot diagram 2015-07-17 12:43:46 +01:00
298602768e doc: changing theme to "classic" to be compatible with new version of sphinx 2015-07-17 12:43:25 +01:00
b25f7ec4a3 Updated installation docs with warning about potential permission issues. 2015-06-26 10:23:39 +01:00
ccea63555c Added retries
Failed jobs will now be automatically retired. This is controlled by two
new settings:

retry_on_status - a list of statuses which will be consided failures and
                  result in a retry
max_retries - number of retries before giving up
2015-06-18 16:46:26 +01:00
e357a46b62 Documenting the Workload initialize and finalize methods 2015-06-11 18:17:53 +01:00
084de2e58c Adding an illustration for DAQ wiring. 2015-06-09 11:03:26 +01:00