gerrit/Documentation/cmd-version.txt
Yuxuan 'fishy' Wang 61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00

46 lines
1.3 KiB
Plaintext

= gerrit version
== NAME
gerrit version - Show the version of the currently executing Gerrit server
== SYNOPSIS
--
'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
---------