1444421 - Restore relevant mozdevice documentation

Status: RESOLVED FIXED

(Testing :: Mozbase, enhancement)

Description

[Geoff Brown [:gbrown]]

https://hg.mozilla.org/mozilla-central/rev/30820b7d399b, bug 1340584, removed SUTAgent, and with it, irrelevant documentation. It also accidentally removed some relevant documentation -- I should put that back!

Comment 1

[Geoff Brown [:gbrown]]

Attachment: restore mozdevice docs

I restored the mozdevice docs from bug 1340584, removed DeviceManager references, then added entries for new functions added in bug 1440714: get_file, get_top_activity, launch_geckoview_example.

Comment 2

[Bob Clary [:bc] (inactive)]

Comment on attachment 8960354 [details] [diff] [review]
restore mozdevice docs

Review of attachment 8960354 [details] [diff] [review]:
-----------------------------------------------------------------

lgtm. 1 nit that needs to be fixed (the i- thing) and two that are optional.
r+

::: testing/mozbase/docs/devicemanagement.rst
@@ +2,5 @@
> +-----------------
> +
> +Mozbase provides a module called `mozdevice` for the purposes of
> +running automated tests or scripts on a device (e.g. an Android
> +phone, tablet, or emulator) connected to a workstation.

Perhaps...

Mozbase provides a module called `mozdevice` for the purposes of
running automated tests or scripts on an Android or B2G device (e.g. a 
phone, tablet, or emulator) connected to a workstation.

::: testing/mozbase/docs/mozdevice.rst
@@ +1,1 @@
> +i-:mod:`mozdevice` --- Interact with remote devices

:mod:`mozdevice` --- Interact with Android or B2G devices

@@ +3,5 @@
> +
> +Mozdevice provides several interfaces to interact with a remote device
> +such as an Android phone, tablet, or emulator. It allows you to push
> +files to these types of devices, launch processes, and more. There are
> +currently two available interfaces:

Perhaps...

Mozdevice provides several interfaces to interact with an Android or B2G device
such as a phone, tablet, or emulator. It allows you to push
files to these types of devices, launch processes, and more. There are
currently two available interfaces:

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/1cadf33d7b48
Restore some mozdevice documentation; r=bc

Comment 4

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/1cadf33d7b48