michael@0: :mod:`mozversion` --- Get application information
michael@0: =================================================
michael@0: 
michael@0: `mozversion <https://github.com/mozilla/mozbase/tree/master/mozversion>`_
michael@0: provides version information such as the application name and the changesets
michael@0: that it has been built from. This is commonly used in reporting or for
michael@0: conditional logic based on the application under test.
michael@0: 
michael@0: API Usage
michael@0: ---------
michael@0: 
michael@0: .. automodule:: mozversion
michael@0:     :members: get_version
michael@0: 
michael@0: 
michael@0: Command Line Usage
michael@0: ------------------
michael@0: 
michael@0: mozversion comes with a command line program, ``mozversion`` which may be used to
michael@0: get version information from an application.
michael@0: 
michael@0: Usage::
michael@0: 
michael@0:     mozversion [options]
michael@0: 
michael@0: Options
michael@0: ```````
michael@0: 
michael@0: ---binary
michael@0: '''''''''
michael@0: 
michael@0: This is the path to the target application binary. If this is omitted then
michael@0: the current directory is checked for the existance of an application.ini file.
michael@0: If not found, then it is assumed the target application is a remote Firefox OS
michael@0: instance.
michael@0: 
michael@0: 
michael@0: ---sources
michael@0: ''''''''''
michael@0: 
michael@0: The path to the sources.xml that accompanies the target application (Firefox OS
michael@0: only). If this is omitted then the current directory is checked for the
michael@0: existance of a sources.xml file.
michael@0: 
michael@0: Examples
michael@0: ````````
michael@0: 
michael@0: Firefox::
michael@0: 
michael@0:     $ mozversion --binary=/path/to/firefox-bin
michael@0:     application_buildid: 20131205075310
michael@0:     application_changeset: 39faf812aaec
michael@0:     application_name: Firefox
michael@0:     application_repository: http://hg.mozilla.org/releases/mozilla-release
michael@0:     application_version: 26.0
michael@0:     platform_buildid: 20131205075310
michael@0:     platform_changeset: 39faf812aaec
michael@0:     platform_repository: http://hg.mozilla.org/releases/mozilla-release
michael@0: 
michael@0: Firefox OS::
michael@0: 
michael@0:     $ mozversion --sources=/path/to/sources.xml
michael@0:     application_buildid: 20140106040201
michael@0:     application_changeset: 14ac61461f2a
michael@0:     application_name: B2G
michael@0:     application_repository: http://hg.mozilla.org/mozilla-central
michael@0:     application_version: 29.0a1
michael@0:     build_changeset: 59605a7c026ff06cc1613af3938579b1dddc6cfe
michael@0:     device_firmware_date: 1380051975
michael@0:     device_firmware_version_incremental: 139
michael@0:     device_firmware_version_release: 4.0.4
michael@0:     device_id: msm7627a
michael@0:     gaia_changeset: 9a222ac02db176e47299bb37112ae40aeadbeca7
michael@0:     gaia_date: 1389005812
michael@0:     gecko_changeset: 3a2d8af198510726b063a217438fcf2591f4dfcf
michael@0:     platform_buildid: 20140106040201
michael@0:     platform_changeset: 14ac61461f2a
michael@0:     platform_repository: http://hg.mozilla.org/mozilla-central