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
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
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
51955ee0e0
doc: add metadata docs
...
Document the new metadata feature.
2018-05-25 15:27:14 +01:00
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
61ca603049
doc: add serialization documentation
2018-05-25 15:27:14 +01:00
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
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
a32e7e7bc7
doc/plugin: Add instrument backends to plugin reference
...
Add documentation for the energy instrument.
2018-05-24 16:57:47 +01:00
cacc4dec8b
doc: Update RebootPolicy and ExectionOrder information
2018-05-23 10:14:34 +01:00
bea36cc398
doc: Update output_api references
2018-05-21 10:26:28 +01:00
04fe3768af
doc: Misc fixes
...
Fix typos, formatting and irrelevant information.
2018-05-21 10:26:28 +01:00
f4dd1a1c84
doc/migration_guide: Add additional parameter changes
2018-05-21 10:26:28 +01:00
4f295af96c
doc/index: Update intro description of WA.
2018-05-21 10:26:28 +01:00
978d43b33d
doc: Update linaro link
2018-05-21 10:26:28 +01:00
b3d34e25ff
doc: Update sysfile documentation.
...
Remove duplicated information and added link to additional
documentation.
2018-05-21 10:26:28 +01:00
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
