testing/mozbase/docs/mozversion.rst@6474c204b198 (annotated)
testing/mozbase/docs/mozversion.rst
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | :mod:`mozversion` --- Get application information |
| michael@0 | 2 | ================================================= |
| michael@0 | 3 | |
| michael@0 | 4 | `mozversion <https://github.com/mozilla/mozbase/tree/master/mozversion>`_ |
| michael@0 | 5 | provides version information such as the application name and the changesets |
| michael@0 | 6 | that it has been built from. This is commonly used in reporting or for |
| michael@0 | 7 | conditional logic based on the application under test. |
| michael@0 | 8 | |
| michael@0 | 9 | API Usage |
| michael@0 | 10 | --------- |
| michael@0 | 11 | |
| michael@0 | 12 | .. automodule:: mozversion |
| michael@0 | 13 | :members: get_version |
| michael@0 | 14 | |
| michael@0 | 15 | |
| michael@0 | 16 | Command Line Usage |
| michael@0 | 17 | ------------------ |
| michael@0 | 18 | |
| michael@0 | 19 | mozversion comes with a command line program, ``mozversion`` which may be used to |
| michael@0 | 20 | get version information from an application. |
| michael@0 | 21 | |
| michael@0 | 22 | Usage:: |
| michael@0 | 23 | |
| michael@0 | 24 | mozversion [options] |
| michael@0 | 25 | |
| michael@0 | 26 | Options |
| michael@0 | 27 | ``````` |
| michael@0 | 28 | |
| michael@0 | 29 | ---binary |
| michael@0 | 30 | ''''''''' |
| michael@0 | 31 | |
| michael@0 | 32 | This is the path to the target application binary. If this is omitted then |
| michael@0 | 33 | the current directory is checked for the existance of an application.ini file. |
| michael@0 | 34 | If not found, then it is assumed the target application is a remote Firefox OS |
| michael@0 | 35 | instance. |
| michael@0 | 36 | |
| michael@0 | 37 | |
| michael@0 | 38 | ---sources |
| michael@0 | 39 | '''''''''' |
| michael@0 | 40 | |
| michael@0 | 41 | The path to the sources.xml that accompanies the target application (Firefox OS |
| michael@0 | 42 | only). If this is omitted then the current directory is checked for the |
| michael@0 | 43 | existance of a sources.xml file. |
| michael@0 | 44 | |
| michael@0 | 45 | Examples |
| michael@0 | 46 | ```````` |
| michael@0 | 47 | |
| michael@0 | 48 | Firefox:: |
| michael@0 | 49 | |
| michael@0 | 50 | $ mozversion --binary=/path/to/firefox-bin |
| michael@0 | 51 | application_buildid: 20131205075310 |
| michael@0 | 52 | application_changeset: 39faf812aaec |
| michael@0 | 53 | application_name: Firefox |
| michael@0 | 54 | application_repository: http://hg.mozilla.org/releases/mozilla-release |
| michael@0 | 55 | application_version: 26.0 |
| michael@0 | 56 | platform_buildid: 20131205075310 |
| michael@0 | 57 | platform_changeset: 39faf812aaec |
| michael@0 | 58 | platform_repository: http://hg.mozilla.org/releases/mozilla-release |
| michael@0 | 59 | |
| michael@0 | 60 | Firefox OS:: |
| michael@0 | 61 | |
| michael@0 | 62 | $ mozversion --sources=/path/to/sources.xml |
| michael@0 | 63 | application_buildid: 20140106040201 |
| michael@0 | 64 | application_changeset: 14ac61461f2a |
| michael@0 | 65 | application_name: B2G |
| michael@0 | 66 | application_repository: http://hg.mozilla.org/mozilla-central |
| michael@0 | 67 | application_version: 29.0a1 |
| michael@0 | 68 | build_changeset: 59605a7c026ff06cc1613af3938579b1dddc6cfe |
| michael@0 | 69 | device_firmware_date: 1380051975 |
| michael@0 | 70 | device_firmware_version_incremental: 139 |
| michael@0 | 71 | device_firmware_version_release: 4.0.4 |
| michael@0 | 72 | device_id: msm7627a |
| michael@0 | 73 | gaia_changeset: 9a222ac02db176e47299bb37112ae40aeadbeca7 |
| michael@0 | 74 | gaia_date: 1389005812 |
| michael@0 | 75 | gecko_changeset: 3a2d8af198510726b063a217438fcf2591f4dfcf |
| michael@0 | 76 | platform_buildid: 20140106040201 |
| michael@0 | 77 | platform_changeset: 14ac61461f2a |
| michael@0 | 78 | platform_repository: http://hg.mozilla.org/mozilla-central |
