opendev/gerrit
Code Issues Proposed changes

Add missing documentation of SSH "version" command

Browse Source 
Commit 018332f added a "version" command in the SSH daemon,
but the new command was never documented.

Change-Id: I3f0aeec106d01edd4fb674d1b34daad1da3e9ab9
This commit is contained in:
Magnus Bäck 2012-09-25 12:20:39 -04:00
parent 8d8a7f0b61
commit f9b41a4c62
2 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/cmd-index.txt
View File

@ -81,6 +81,9 @@ link:cmd-review.html[gerrit review]::
link:cmd-stream-events.html[gerrit stream-events]::
Monitor events occurring in real time.
link:cmd-version.html[gerrit version]::
Show the currently executing version of Gerrit.
git upload-pack::
Standard Git server side command for client side `git fetch`.

48
Documentation/cmd-version.txt Normal file
View File

@ -0,0 +1,48 @@
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]