sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 02:41:11 +01:00
Code Issues Releases Wiki Activity
1,479 Commits 4 Branches 16 Tags 180 MiB
275c243764
Commit Graph

99 Commits

Author SHA1 Message Date
Sergei Trofimov
275c243764 doc: add output API docs 
- Add a reference tag for metadata
- Remove doc/source/api from .gitignore -- this is no longer
  auto-generated.
- Add a top-level "index" for the API documentation.
- Add output API documentation.
- Remove the output API example file, as its contents is now part of the
  output API docs.
 2018-06-25 17:11:47 +01:00
Sergei Trofimov
c400591759 doc: update glossary 
Add a few more terms that have special meaning in the context of WA to
the glossary.
 2018-06-25 17:11:47 +01:00
Waleed El-Geresy
7941b712c5 docs/user_guide: Fix wa create example command 2018-06-14 15:59:16 +01:00
Sergei Trofimov
5f7fde206d fw/instrument: add hostside decorator 
Add a decorator to indicate that a callback runs entirely host-side and
does not rely on a connection to the target. This  means it will be
invoked even if the target was detected to be unresponsive.
 2018-06-12 16:07:53 +01:00
Marc Bonnici
b4b6f949cc doc: Add overview of how WA config merging works 2018-06-11 08:10:07 +01:00
Marc Bonnici
aa4dbebcb6 doc: Add initial version of a glossary 2018-06-11 08:10:07 +01:00
Marc Bonnici
b7e17759a3 doc/faq: Add solution for Juno resetting upon commencing a WA run 2018-06-11 08:10:07 +01:00
Marc Bonnici
9d14cb0a48 doc: Update dependencies and installation for Python 3 support 2018-06-11 08:10:07 +01:00
Marc Bonnici
bde3df8172 doc: Restructure API documentation 2018-06-11 08:10:07 +01:00
Marc Bonnici
a425fbf4d3 doc: Add additional API docs 2018-06-11 08:10:07 +01:00
Marc Bonnici
ae09ef174b doc/method_map_template: Update to refer to signal dispatch diagram 2018-06-11 08:10:07 +01:00
Marc Bonnici
0196d3bdbe doc: Update Output processing API docs 2018-06-11 08:10:07 +01:00
Marc Bonnici
4b5d85ce40 doc: Add WA execution model. 
Add brief overview of WA's execution model.
 2018-06-11 08:10:07 +01:00
Marc Bonnici
92df8852fd doc: Rename references to folder to directory to be consistent. 2018-06-11 08:10:07 +01:00
Marc Bonnici
13d0743ac3 doc/contributing: Fix typos 2018-06-11 08:10:07 +01:00
Marc Bonnici
c7af8f497f doc: Fix typos in method map template 2018-06-11 08:10:07 +01:00
Marc Bonnici
3839da166d doc: Fix instrument documentation 
Fixed outdated `update_results` method references.
 2018-06-11 08:10:07 +01:00
Marc Bonnici
e80feef486 doc: Add agenda user reference documentation. 2018-06-11 08:10:07 +01:00
Marc Bonnici
50f06388be doc/revent: Fix workload name typo 2018-06-11 08:10:07 +01:00
Marc Bonnici
dbe98edd7d doc: Reword introduction paragraph 2018-06-11 08:10:07 +01:00
Waleed El-Geresy
0269a30ca6 docs:writing_plugins: Typos and Grammar 2018-06-08 17:50:22 +01:00
sdpenguin
1a98b8a4d3 Typo fix 2018-06-08 17:12:02 +01:00
Sergei Trofimov
b3de85455a Add support for Python 3 
Add support for running under Python 3, while maintaining compatibility
with Python 2.

See http://python-future.org/compatible_idioms.html for more details
behind these changes.
 2018-06-07 14:48:40 +01:00
Sergei Trofimov
0dc9390978 doc: jazz up "What's new" section 
- Reword the intro and add a solicitation for porting requests.
- Move "new features" to above "changes".
- List a bunch of additional new features.
 2018-05-25 16:56:59 +01:00
Sergei Trofimov
3545c855b8 doc: add note on classifiers vs metadata 
Add a small section on classifiers to the plugin writing docs, and a
section comparing them with metadata and clarifying when to use one or
the other.
 2018-05-25 15:27:14 +01:00
Sergei Trofimov
51955ee0e0 doc: add metadata docs 
Document the new metadata feature.
 2018-05-25 15:27:14 +01:00
Sergei Trofimov
63fe32584b doc: update metrics and artifacts docs 
Update documentation for metrics and artifacts documentation to show
how these may be added by a plugin.
 2018-05-25 15:27:14 +01:00
Sergei Trofimov
61ca603049 doc: add serialization documentation 2018-05-25 15:27:14 +01:00
Sergei Trofimov
e5e8406e1f doc: minor fix to resource resolution docs 
Correct the documentation for what happens if a resource is not found.
 2018-05-25 10:21:06 +01:00
Sergei Trofimov
79141582e9 fw/workload: record app version in metadata 
Add the package version for an ApkWorkload to the metadata for that job.
 2018-05-25 10:21:06 +01:00
Marc Bonnici
a32e7e7bc7 doc/plugin: Add instrument backends to plugin reference 
Add documentation for the energy instrument.
 2018-05-24 16:57:47 +01:00
Marc Bonnici
cacc4dec8b doc: Update RebootPolicy and ExectionOrder information 2018-05-23 10:14:34 +01:00
Marc Bonnici
bea36cc398 doc: Update output_api references 2018-05-21 10:26:28 +01:00
Marc Bonnici
04fe3768af doc: Misc fixes 
Fix typos, formatting and irrelevant information.
 2018-05-21 10:26:28 +01:00
Marc Bonnici
f4dd1a1c84 doc/migration_guide: Add additional parameter changes 2018-05-21 10:26:28 +01:00
Marc Bonnici
4f295af96c doc/index: Update intro description of WA. 2018-05-21 10:26:28 +01:00
Marc Bonnici
978d43b33d doc: Update linaro link 2018-05-21 10:26:28 +01:00
Marc Bonnici
b3d34e25ff doc: Update sysfile documentation. 
Remove duplicated information and added link to additional
documentation.
 2018-05-21 10:26:28 +01:00
Marc Bonnici
700989298c doc: Correct ID names 2018-05-21 10:26:28 +01:00
Marc Bonnici
69462e54a1 doc: Update APK workload parameter descriptions. 
Clarify parameter descriptions.
 2018-05-21 10:26:28 +01:00
Marc Bonnici
5c6cc87105 doc: Update sections example. 
Modify documention and example to better explain sections
 2018-05-21 10:26:28 +01:00
Marc Bonnici
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
Marc Bonnici
52b2df427e doc/show_cmd: Reword description and add settings option 2018-05-21 10:26:28 +01:00
Marc Bonnici
9986423365 doc: Add documentation for the process command 2018-05-21 10:26:28 +01:00
Sergei Trofimov
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
Sergei Trofimov
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
Sergei Trofimov
b1b2131b0c doc: fix build warnings 2018-05-18 10:32:08 +01:00
Sergei Trofimov
d0368cf176 doc: re-write augmentations docs 
Rewrite the "Output processors and Instruments" section into
"Augmentations" section.
 2018-05-14 17:08:14 +01:00
Sergei Trofimov
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
Sergei Trofimov
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