Add documentation for the SSH 'test-submit type' command

Change-Id: I7fa8e722bd2dfda55882286f15ce62b7f8a78d68
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2013-03-26 10:41:46 +01:00
parent 3e6303c556
commit 48a9e0d4b9
2 changed files with 56 additions and 0 deletions

View File

@@ -159,6 +159,9 @@ link:cmd-plugin-remove.html[gerrit plugin rm]::
link:cmd-test-submit-rule.html[gerrit test-submit-rule]::
Test prolog submit rules.
link:cmd-test-submit-type.html[gerrit test-submit type]::
Test prolog submit type.
link:cmd-kill.html[kill]::
Kills a scheduled or running task.

View File

@@ -0,0 +1,53 @@
gerrit test-submit type
=======================
NAME
----
gerrit test-submit type - Test prolog submit type with a chosen change.
SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit test-submit type'
[-s]
[--no-filters]
CHANGE
DESCRIPTION
-----------
Provides a way to test prolog submit type.
OPTIONS
-------
-s::
Reads a rules.pl file from stdin instead of rules.pl in refs/meta/config.
--no-filters::
Don't run the submit_type_filter/2 from the parent projects of the specified change.
ACCESS
------
Can be used by anyone that has permission to read the specified change.
EXAMPLES
--------
Test submit_type from stdin and return the submit type.
====
cat rules.pl | ssh -p 29418 review.example.com gerrit test-submit type -s I78f2c6673db24e4e92ed32f604c960dc952437d9
"MERGE_IF_NECESSARY"
====
Test the active submit_type from the refs/meta/config branch, ignoring filters in the project parents.
====
$ ssh -p 29418 review.example.com gerrit test-submit type I78f2c6673db24e4e92ed32f604c960dc952437d9 --no-filters
"MERGE_IF_NECESSARY"
====
SCRIPTING
---------
Can be used either interactively for testing new prolog submit type, or from a script to check the submit type of a change.
GERRIT
------
Part of link:index.html[Gerrit Code Review]