blob: d5c2263bffa1fbbcc8093ed8870ea393cac67f13 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit version
Magnus Bäckf9b41a42012-09-25 12:20:39 -04002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Magnus Bäckf9b41a42012-09-25 12:20:39 -04004gerrit version - Show the version of the currently executing Gerrit server
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
Magnus Bäckf9b41a42012-09-25 12:20:39 -04008'ssh' -p <port> <host> 'gerrit version'
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08009--
Magnus Bäckf9b41a42012-09-25 12:20:39 -040010
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080011== DESCRIPTION
Magnus Bäckf9b41a42012-09-25 12:20:39 -040012Displays a one-line response with the string `gerrit version` followed
13by the currently executing version of Gerrit.
14
15The `git describe` command is used to generate the version string based
16on the Git commit used to build Gerrit. For official releases of Gerrit,
17the version string will be equal to the Git tag set in the Gerrit source
18code, which in turn is equal to the name of the release (for example
192.4.2). When building Gerrit from another commit (one that doesn't have
20an official-looking tag pointing to it), the version string has the form
21`<tagname>-<n>-g<sha1>`, where `<n>` is an integer indicating the number
22of commits ahead of the `<tagname>` tag the commit is, and `<sha1>` is
23the seven-character abbreviated SHA-1 of the commit. See the `git
24describe` documentation for details on how `<tagname>` is chosen and how
25`<n>` is computed.
26
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080027== ACCESS
Magnus Bäckf9b41a42012-09-25 12:20:39 -040028Any user who has configured an SSH key.
29
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080030== SCRIPTING
Magnus Bäckf9b41a42012-09-25 12:20:39 -040031This command is intended to be used in scripts.
32
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080033== EXAMPLES
Magnus Bäckf9b41a42012-09-25 12:20:39 -040034
35=====
36 $ ssh -p 29418 review.example.com gerrit version
37 gerrit version 2.4.2
38=====
39
40GERRIT
41------
42Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070043
44SEARCHBOX
45---------