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
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
bbb5cb9643
doc/build_plugin_docs: Only load the required plugins
...
When updating the pluginload only load the modules we want to document
rather than load all avalible and then filter.
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
Sergei Trofimov
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
Marc Bonnici
66fa8c856a
doc: Fix code highlighting
2018-05-14 16:34:10 +01:00
Marc Bonnici
c12bdea1af
doc/requirements: Fix online code highlighting
...
The default version of the readthedocs theme does not support code
highlighting correctly so manually specify a compatible version as per
https://github.com/rtfd/readthedocs.org/issues/4072
2018-05-14 16:34:10 +01:00
Marc Bonnici
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
Marc Bonnici
087c18c752
doc/migration_guide: Add references to confvalues
2018-05-11 18:06:24 +01:00