From f9b41a4c620a8f47f3c4bcd0ed3df64ace33910f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20B=C3=A4ck?= Date: Tue, 25 Sep 2012 12:20:39 -0400 Subject: [PATCH] Add missing documentation of SSH "version" command Commit 018332f added a "version" command in the SSH daemon, but the new command was never documented. Change-Id: I3f0aeec106d01edd4fb674d1b34daad1da3e9ab9 --- Documentation/cmd-index.txt | 3 +++ Documentation/cmd-version.txt | 48 +++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 Documentation/cmd-version.txt diff --git a/Documentation/cmd-index.txt b/Documentation/cmd-index.txt index 3895b905c0..55cb4562db 100644 --- a/Documentation/cmd-index.txt +++ b/Documentation/cmd-index.txt @@ -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`. diff --git a/Documentation/cmd-version.txt b/Documentation/cmd-version.txt new file mode 100644 index 0000000000..d1f94ea3c1 --- /dev/null +++ b/Documentation/cmd-version.txt @@ -0,0 +1,48 @@ +gerrit version +================ + +NAME +---- +gerrit version - Show the version of the currently executing Gerrit server + +SYNOPSIS +-------- +[verse] +'ssh' -p '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 +`--g`, where `` is an integer indicating the number +of commits ahead of the `` tag the commit is, and `` is +the seven-character abbreviated SHA-1 of the commit. See the `git +describe` documentation for details on how `` is chosen and how +`` 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]