Marc Bonnici
3c467dce95
doc: Fix missing import in Getter example
2018-06-26 16:25:05 +01:00
Marc Bonnici
3ed14e9864
doc: Fix instrument update_output
method description
2018-06-26 16:25:05 +01:00
Marc Bonnici
af8bc42cc2
doc: Update resolver example to use context directly
2018-06-26 16:25:05 +01:00
Marc Bonnici
60e9f08ebc
doc/glossary: Fix incorrect reference for Output Processors entry
2018-06-26 16:25:05 +01:00
Marc Bonnici
37d6433214
doc: Improve Adding a Workload
how to
2018-06-26 16:25:05 +01:00
Marc Bonnici
23eb428829
doc: Add additional references and formatting
2018-06-26 16:25:05 +01:00
Marc Bonnici
2f94d12b57
doc: Restructure developer information
...
Re-organise and add additional information to developer guide.
2018-06-26 16:25:05 +01:00
Marc Bonnici
a64bb3a26f
doc/api: Add workload APIs
2018-06-26 16:25:05 +01:00
Marc Bonnici
750e206b85
doc/dev_reference: Update to use correct API formatting
...
Update the interfaces for Workloads OutputProcessors and Instruments to be
formatted as an API correctly.
2018-06-26 16:25:05 +01:00
Marc Bonnici
9d160b1381
doc/execution_model: Remove unintentional heading
2018-06-26 16:25:05 +01:00
Marc Bonnici
d637557f5a
doc: Update links to have more useful display text
2018-06-26 16:25:05 +01:00
Marc Bonnici
716af1b966
doc: Make config listsing a consistent style
2018-06-26 16:25:05 +01:00
Marc Bonnici
b6e91630b8
doc/user_reference: Restructure Agenda reference
2018-06-26 16:25:05 +01:00
Marc Bonnici
6c93590062
doc: Restructure
...
Restructure the documentation to be split into `User Information` and
`Developer Information`, and split the how to guides into their
corresponding section.
2018-06-26 16:25:05 +01:00
Marc Bonnici
d4aad394d7
doc/index: Update intro paragraph
...
Update number of workloads and add note to guide users to the plugin
reference for documentation of individual plugins.
2018-06-25 18:19:30 +01:00
Marc Bonnici
df076c68da
templates: Add parameter example to UiAutomator template.
...
Add additional information to the UiAutomator template for retrieving
parameters.
2018-06-25 18:19:30 +01:00
Marc Bonnici
e672fbed32
doc/execution_model: Add details about optional setup_rerun
method
2018-06-25 18:19:30 +01:00
Marc Bonnici
185548d13b
doc/signal_dispatch: Update diagram to incorporate new signals
...
Add new signals to diagram and fix incorrect labels.
2018-06-25 18:19:30 +01:00
Sergei Trofimov
03235d0b59
doc: output API restructure part 2
...
- move TargetInfo and RunInfo docs into the new output API doc
- remove the old developer_reference/APIs.rst as obsolete
- Update output API tag reference to point to the new doc
2018-06-25 17:11:47 +01:00
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
7313c82499
doc: Tidy up method map generation
...
Remove unsed variables and methods from the instrument method map
generation.
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
864ded60ae
fw/instrument: use signal priorities
...
Use signal priorities to define priority decorators, rather than
defining own priority enum.
2018-05-30 12:02:28 +01:00
Sergei Trofimov
e015f438ae
doc/build_instrument_method_map: update table header
...
Update the decorator stable header to state "decorator" rather than
"prefix" (this was left over from WA2).
2018-05-30 12:02:28 +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