1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-05 18:31:12 +01:00
Commit Graph

201 Commits

Author SHA1 Message Date
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
Marc Bonnici
19184ceaf6 doc: Update reference and fix typos 2018-05-11 18:06:24 +01:00
Marc Bonnici
86cc449203 doc: Improve description of context methods 2018-05-11 18:06:24 +01:00
Marc Bonnici
48a7ad9415 doc/output: Update output directory information 2018-05-11 18:06:24 +01:00
Marc Bonnici
9d0127d685 doc/installation: Fix formatting 2018-05-11 18:06:24 +01:00
Marc Bonnici
9251febafb doc/build_plugin_doc: Fix typo in function name 2018-05-11 18:06:24 +01:00
sergei Trofimov
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
Marc Bonnici
98e86efbda doc: Fix references 2018-04-30 09:14:22 +01:00
Marc Bonnici
2aeaedb8bc doc/build_plugin_docs: Improve plugin formatting.
Add a table of contents to the plugin list page along with page breaks
to divide things up.
2018-04-30 09:14:22 +01:00
Marc Bonnici
7cb11f66cf doc: add building of instrument method map 2018-04-30 09:14:22 +01:00
Marc Bonnici
9741014b35 doc: Fix formatting errors 2018-04-30 09:14:22 +01:00
Marc Bonnici
0fd095622c doc: Improve installing executables documentation 2018-04-30 09:14:22 +01:00
Marc Bonnici
1f9a233214 doc/agenda: Add documentation about classifiers 2018-04-30 09:14:22 +01:00
Marc Bonnici
c1171263f9 doc/faq: Add solution to "Unknown runtime parameter" 2018-04-30 09:14:22 +01:00
Marc Bonnici
504703d444 doc/migration_guide: Fix typo 2018-04-30 09:14:22 +01:00
Marc Bonnici
61a9c96a7d doc/device_setup: Add examples of installing modules to target 2018-04-30 09:14:22 +01:00
Marc Bonnici
f60b7eca16 doc/output_api: Improve examples 2018-04-30 09:14:22 +01:00
Marc Bonnici
8c9c1a8f1e docs/user_guide: Clarify basic run command information. 2018-04-30 09:14:22 +01:00
Marc Bonnici
81c6da9c2c Documentation: Add support for generating common target api 2018-04-30 09:14:22 +01:00
Marc Bonnici
d3efb1fda1 doc/requirements: Add explict requirements for numpy and pandas
Add these requirements so that they are installed into the readthedocs
environment before building the documentation. If left to use the
default installation method the build process times out.
2018-04-24 09:59:57 +01:00
Marc Bonnici
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
Marc Bonnici
1fede5e3f3 doc/build_plugin_docs: Add support for core config generation 2018-04-24 09:59:57 +01:00
Sergei Trofimov
60fbd17fab doc/revent: add missing verbatim block markup 2018-02-22 08:41:04 +00:00
Sergei Trofimov
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
Sergei Trofimov
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
Sergei Trofimov
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
Sebastian Goscik
c51593a729 pluginloader: Updated documentation to say plugin instead of extension 2016-09-27 11:17:25 +01:00
Brendan Jackman
2ae8c6073f doc: Apply it's/its grammar pedantry 2016-01-25 13:34:24 +00:00
Sebastian Goscik
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
Sebastian Goscik
67213d471b BaseLinuxDevice: documentation update
Added docs explaining how extension developers should deploy binaries.
2016-01-19 10:45:09 +00:00
Sergei Trofimov
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
Sebastian Goscik
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
Sergei Trofimov
6e447aa8b2 docs: typo 2015-09-07 17:55:42 +01:00
Sergei Trofimov
47b2081ccb doc: fixing daq wiring screenshot diagram 2015-07-17 12:43:46 +01:00
Sergei Trofimov
298602768e doc: changing theme to "classic" to be compatible with new version of sphinx 2015-07-17 12:43:25 +01:00
Sergei Trofimov
b25f7ec4a3 Updated installation docs with warning about potential permission issues. 2015-06-26 10:23:39 +01:00
Sergei Trofimov
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
Sergei Trofimov
e357a46b62 Documenting the Workload initialize and finalize methods 2015-06-11 18:17:53 +01:00
Sergei Trofimov
084de2e58c Adding an illustration for DAQ wiring. 2015-06-09 11:03:26 +01:00
Sergei Trofimov
bf189dbe6a mino doc tweak. 2015-06-03 16:20:48 +01:00
Sergei Trofimov
c550657912 Updating contribution guidelines.
Clarifying style guidelines and refering "Writing Extensions" section.
2015-06-01 10:36:21 +01:00
Sergei Trofimov
2f1c7300d4 doc: documenting remote_assets_path
Adding documentation explaining how to use remote_assets_path setting.
2015-05-05 14:52:39 +01:00
Lisa Nguyen
b41d316fd6 doc/source: Add details about running WA on Linux
Mention in the documentation that Android SDK is optional for
users who plan to run WA on Linux devices only, and how they
would only be able to start running a limited number of workloads.

Also included a few trivial fixes such as spelling errors and
moving sentences around to improve flow.

Signed-off-by: Lisa Nguyen <lisa.nguyen@linaro.org>
2015-04-10 08:22:01 +01:00
Lisa Nguyen
0421b58c55 doc/source: Add uninstall and upgrade sections
Add the uninstall and upgrade commands for users to remove or
upgrade Workload Automation for future reference.

Signed-off-by: Lisa Nguyen <lisa.nguyen@linaro.org>
2015-04-01 17:19:02 +01:00
Lisa Nguyen
58ab762131 doc/source: Update quickstart
Update the quickstart guide to include steps for setting
up WA to run on Linux devices.

Signed-off-by: Lisa Nguyen <lisa.nguyen@linaro.org>
2015-03-26 17:51:51 +00:00
Kevin Hilman
d4ee737e50 doc: device_setup: fix generic_linux device_config example
A copy/paste of the documentation example results in a python
backtrace because the dict keys cannot be quoted:

    wlauto.exceptions.ConfigError: Sytax error in config: keyword can't be an expression (config.py, line XYZ)

Fix by removing the quotes from the keys in the example.

Signed-off-by: Kevin Hilman <khilman@linaro.org>
2015-03-23 09:24:40 +00:00
Sergei Trofimov
2f7acfd87a Added "post install" section to installation docs.
This section lists workloads that require additional external
dependencies.
2015-03-18 10:51:39 +00:00
Sergei Trofimov
aa74e1e8f5 Minor fix to rst table generation.
Updated format_simple_table to take headers into account when
calculating column widths. Also updated docs where it currently used.
2015-03-18 10:47:07 +00:00
Sergei Trofimov
db7a525bc7 Fixing broken label in documentation. 2015-03-11 16:05:17 +00:00
Sergei Trofimov
a747ec7e4c Initial commit of open source Workload Automation. 2015-03-10 13:09:31 +00:00