From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 testing/mozbase/docs/mozversion.rst | 70 +++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 testing/mozbase/docs/mozversion.rst

(limited to 'testing/mozbase/docs/mozversion.rst')

diff --git a/testing/mozbase/docs/mozversion.rst b/testing/mozbase/docs/mozversion.rst
new file mode 100644
index 0000000000..ca2be48c1f
--- /dev/null
+++ b/testing/mozbase/docs/mozversion.rst
@@ -0,0 +1,70 @@
+:mod:`mozversion` --- Get application information
+=================================================
+
+`mozversion <https://hg.mozilla.org/mozilla-central/file/tip/testing/mozbase/mozversion>`_
+provides version information such as the application name and the changesets
+that it has been built from. This is commonly used in reporting or for
+conditional logic based on the application under test.
+
+API Usage
+---------
+
+.. automodule:: mozversion
+    :members: get_version
+
+Examples
+````````
+
+Firefox::
+
+    import mozversion
+
+    version = mozversion.get_version(binary='/path/to/firefox')
+    for (key, value) in sorted(version.items()):
+        if value:
+            print '%s: %s' % (key, value)
+
+Firefox for Android::
+
+    version = mozversion.get_version(binary='path/to/firefox.apk')
+    print version['application_changeset'] # gets hg revision of build
+
+Command Line Usage
+------------------
+
+mozversion comes with a command line program, ``mozversion`` which may be used to
+get version information from an application.
+
+Usage::
+
+    mozversion [options]
+
+Options
+```````
+
+---binary
+'''''''''
+
+This is the path to the target application binary or .apk. If this is omitted
+then the current directory is checked for the existence of an
+application.ini file. If not found, then it is assumed the target
+application is a remote Firefox OS instance.
+
+Examples
+````````
+
+Firefox::
+
+    $ mozversion --binary=/path/to/firefox-bin
+    application_buildid: 20131205075310
+    application_changeset: 39faf812aaec
+    application_name: Firefox
+    application_repository: http://hg.mozilla.org/releases/mozilla-release
+    application_version: 26.0
+    platform_buildid: 20131205075310
+    platform_changeset: 39faf812aaec
+    platform_repository: http://hg.mozilla.org/releases/mozilla-release
+
+Firefox for Android::
+
+    $ mozversion --binary=/path/to/firefox.apk
-- 
cgit v1.2.3