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.

     1 :mod:`mozversion` --- Get application information
     2 =================================================
     4 `mozversion <https://github.com/mozilla/mozbase/tree/master/mozversion>`_
     5 provides version information such as the application name and the changesets
     6 that it has been built from. This is commonly used in reporting or for
     7 conditional logic based on the application under test.
     9 API Usage
    10 ---------
    12 .. automodule:: mozversion
    13     :members: get_version
    16 Command Line Usage
    17 ------------------
    19 mozversion comes with a command line program, ``mozversion`` which may be used to
    20 get version information from an application.
    22 Usage::
    24     mozversion [options]
    26 Options
    27 ```````
    29 ---binary
    30 '''''''''
    32 This is the path to the target application binary. If this is omitted then
    33 the current directory is checked for the existance of an application.ini file.
    34 If not found, then it is assumed the target application is a remote Firefox OS
    35 instance.
    38 ---sources
    39 ''''''''''
    41 The path to the sources.xml that accompanies the target application (Firefox OS
    42 only). If this is omitted then the current directory is checked for the
    43 existance of a sources.xml file.
    45 Examples
    46 ````````
    48 Firefox::
    50     $ mozversion --binary=/path/to/firefox-bin
    51     application_buildid: 20131205075310
    52     application_changeset: 39faf812aaec
    53     application_name: Firefox
    54     application_repository: http://hg.mozilla.org/releases/mozilla-release
    55     application_version: 26.0
    56     platform_buildid: 20131205075310
    57     platform_changeset: 39faf812aaec
    58     platform_repository: http://hg.mozilla.org/releases/mozilla-release
    60 Firefox OS::
    62     $ mozversion --sources=/path/to/sources.xml
    63     application_buildid: 20140106040201
    64     application_changeset: 14ac61461f2a
    65     application_name: B2G
    66     application_repository: http://hg.mozilla.org/mozilla-central
    67     application_version: 29.0a1
    68     build_changeset: 59605a7c026ff06cc1613af3938579b1dddc6cfe
    69     device_firmware_date: 1380051975
    70     device_firmware_version_incremental: 139
    71     device_firmware_version_release: 4.0.4
    72     device_id: msm7627a
    73     gaia_changeset: 9a222ac02db176e47299bb37112ae40aeadbeca7
    74     gaia_date: 1389005812
    75     gecko_changeset: 3a2d8af198510726b063a217438fcf2591f4dfcf
    76     platform_buildid: 20140106040201
    77     platform_changeset: 14ac61461f2a
    78     platform_repository: http://hg.mozilla.org/mozilla-central

mercurial