Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: ARM-software/devlib
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 252a4fff36d97ccf34c98468e911c8bfb104822e
Choose a base ref
..
head repository: ARM-software/devlib
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 77cada6c22361155cc93e1397e9b8c9d64470dba
Choose a head ref
Showing with 7 additions and 5 deletions.
  1. +6 −4 doc/connection.rst
  2. +1 −1 doc/target.rst
10 changes: 6 additions & 4 deletions doc/connection.rst
Original file line number Diff line number Diff line change
@@ -15,9 +15,8 @@ to be used target is also specified on instantiation by `conn_cls` parameter,
though all concrete :class:`Target` implementations will set an appropriate
default, so there is typically no need to specify this explicitly.

:class:`Connection` classes are not a part of an inheritance hierarchy, i.e.
they do not derive from a common base. Instead, a :class:`Connection` is any
class that implements the following methods.
:class:`Connection` classes derive from
:class:`devlib.conneciton.ConnectionBase` and implement the following methods.


.. method:: push(self, source, dest, timeout=None)
@@ -256,6 +255,9 @@ The only methods discussed below are those that will be overwritten by the
Multipe Connections With One Target
-----------------------------------

.. note:: Multiple parallel connections to the same target are currently not possible
with ``Gem5Connection``.

A ``Target`` will automatically maintain one connection per active thread and
will seemlessly switch between them, so that target commands being executed from
parallel threads won't block each other.
@@ -270,7 +272,7 @@ with conn:
target.execute('ls') # uses conn rather than the default connection.
```

If the connection object is being uses withn another function, you do not need
If the connection object is being used within another function, you do not need
to pass the target into that function as well, as the target will be returned on
entering the connection's context:

2 changes: 1 addition & 1 deletion doc/target.rst
Original file line number Diff line number Diff line change
@@ -190,7 +190,7 @@ Target
Set the Target's connection for the current thread to the one specified
(typically, one that has previously been returned by the call to
``get_connection``). Returns the old connection to the current thread -- it
is up to the coller to keep track of it and restore it if they wish.
is up to the caller to keep track of it and restore it if they wish.

.. method:: Target.setup([executables])