mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-02-20 11:58:55 +00:00
doc: Rename references to folder
to directory
to be consistent.
This commit is contained in:
parent
13d0743ac3
commit
92df8852fd
@ -16,8 +16,8 @@ directory we can initialize a ``RunOutput`` as follows:
|
||||
|
||||
In [1]: from wa import RunOutput
|
||||
...:
|
||||
...: output_folder = 'wa_output'
|
||||
...: run_output = RunOutput(output_folder)
|
||||
...: output_directory = 'wa_output'
|
||||
...: run_output = RunOutput(output_directory)
|
||||
|
||||
|
||||
|
||||
|
@ -48,7 +48,7 @@ Notable methods of the context are:
|
||||
|
||||
context.add_artifact(name, host_file_path, kind, description=None, classifier=None)
|
||||
Plugins can add :ref:`artifacts <artifact>` of various kinds to the run
|
||||
output folder for WA and associate them with a description and/or
|
||||
output directory for WA and associate them with a description and/or
|
||||
:ref:`classifier <classifiers>`.
|
||||
|
||||
context.add_metric(name, value, units=None, lower_is_better=False, classifiers=None)
|
||||
|
@ -186,7 +186,7 @@ therefore we would choose the :ref:`ApkUiAutomator workload
|
||||
Workload created in $WA_USER_DIRECTORY/plugins/google_docs
|
||||
|
||||
|
||||
From here you can navigate to the displayed folder and you will find your
|
||||
From here you can navigate to the displayed directory and you will find your
|
||||
``__init__.py`` and a ``uiauto`` directory. The former is your python WA
|
||||
workload and will look something like this
|
||||
|
||||
|
@ -229,7 +229,7 @@ for most people APK files should be kept in the
|
||||
``$WA_USER_DIRECTORY/dependencies/SOME_WORKLOAD/`` directory. (by default
|
||||
``~/.workload_automation/dependencies/SOME_WORKLOAD/``). The
|
||||
``WA_USER_DIRECTORY`` environment variable can be used to change the location of
|
||||
this folder. The APK files need to be put into the corresponding directories for
|
||||
this directory. The APK files need to be put into the corresponding directories for
|
||||
the workload they belong to. The name of the file can be anything but as
|
||||
explained below may need to contain certain pieces of information.
|
||||
|
||||
|
@ -216,7 +216,7 @@ process automatically accepts the licenses for the Android SDK, so please be
|
||||
sure that you are willing to accept these prior to building and running the
|
||||
image in a container.
|
||||
|
||||
The Dockerfile can be found in the "extras" folder or online at
|
||||
The Dockerfile can be found in the "extras" directory or online at
|
||||
`<https://github.com/ARM-software /workload- automation/blob/next/extras/Dockerfile>`_
|
||||
which contains addional information about how to build and to use the file.
|
||||
|
||||
@ -240,7 +240,7 @@ APKs are application packages used by Android. These are necessary to install on
|
||||
a device when running an :ref:`ApkWorkload <apk-workload>` or derivative. Please
|
||||
see the workload description using the :ref:`show <show-command>` command to see
|
||||
which version of the apk the UI automation has been tested with and place the
|
||||
apk in the corresponding workloads dependency folder. Automation may also work
|
||||
apk in the corresponding workloads dependency directory. Automation may also work
|
||||
with other versions (especially if it's only a minor or revision difference --
|
||||
major version differences are more likely to contain incompatible UI changes)
|
||||
but this has not been tested. As a general rule we do not guarantee support for
|
||||
|
@ -110,7 +110,7 @@ The :ref:`output directory <output_directory>`'s structure has changed layout
|
||||
and now includes additional subdirectories. There is now a ``__meta`` directory
|
||||
that contains copies of the agenda and config files supplied to WA for that
|
||||
particular run so that all the relevant config is self contained. Additionally
|
||||
if one or more jobs fail during a run then corresponding output folder will be
|
||||
if one or more jobs fail during a run then corresponding output directory will be
|
||||
moved into a ``__failed`` subdirectory to allow for quicker analysis.
|
||||
|
||||
|
||||
@ -144,7 +144,7 @@ workload was previously doing this in an ad-hoc manner this should be updated to
|
||||
utilize the new functionality. To make use of this functionality a list of
|
||||
assets should be set as the workload ``deployable_assets`` attribute, these will
|
||||
be automatically retrieved via WA's resource getters and deployed either to the
|
||||
targets working directory or a custom folder specified as the workloads
|
||||
targets working directory or a custom directory specified as the workloads
|
||||
``assets_directory`` attribute. If a custom implementation is required the
|
||||
``deploy_assets`` method should be overridden inside the workload. To allow for
|
||||
the removal of the additional assets any additional file paths should be added
|
||||
|
Loading…
x
Reference in New Issue
Block a user