gerrit/Documentation/cmd-version.txt
Michael Ochmann b99feabd88 Fix formatting of example blocks
With the new stylesheet example blocks (delimited with ====) are
rendered as rather intrusive boxes with large padding in yellow
and grey.

This patch replaces the example blocks with simple code blocks
(delimited with ----) that better match the overall style of the
documentation.

Change-Id: Id95387cdb153332c2066e2d5e378697647dbca52
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-07 14:06:31 +02:00

47 lines
1.3 KiB
Plaintext

= gerrit version
== NAME
gerrit version - Show the version of the currently executing Gerrit server
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit version_
--
== DESCRIPTION
Displays a one-line response with the string `gerrit version` followed
by the currently executing version of Gerrit.
The `git describe` command is used to generate the version string based
on the Git commit used to build Gerrit. For official releases of Gerrit,
the version string will be equal to the Git tag set in the Gerrit source
code, which in turn is equal to the name of the release (for example
2.4.2). When building Gerrit from another commit (one that doesn't have
an official-looking tag pointing to it), the version string has the form
`<tagname>-<n>-g<sha1>`, where `<n>` is an integer indicating the number
of commits ahead of the `<tagname>` tag the commit is, and `<sha1>` is
the seven-character abbreviated SHA-1 of the commit. See the `git
describe` documentation for details on how `<tagname>` is chosen and how
`<n>` is computed.
== ACCESS
Any user who has configured an SSH key.
== SCRIPTING
This command is intended to be used in scripts.
== EXAMPLES
----
$ ssh -p 29418 review.example.com gerrit version
gerrit version 2.4.2
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------