opendev/gerrit
Code Issues Proposed changes

cmd-review.txt: Add clarification in documentation of --force-message

Browse Source 
Add a paragraph in the documentation explaining that if the review
command fails because the user is not permitted to change the label,
the --force-message option will not be effective.

Also fix a couple of minor typos.

Change-Id: I6fdcd54018203a573cd1de3f39f2904f30a0da8a
This commit is contained in:
David Pursehouse
2012-07-24 19:17:59 +09:00
committed by Gustaf Lundh
parent d18f8e6057
commit 27e0e3a076
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/cmd-review.txt
View File

@@ -53,15 +53,18 @@ OPTIONS
--force-message::
Option which allows Gerrit to publish the --message, even
when the labels could not be applied due to the change being
closed).
closed.
+
Used by some scripts/CI-systems, where the results (or links
to the result) are posted as a message after completion of a
build (often together with a label-change, indicating the success
of the build).
+
If the message is posted successfully, the cmd will return
If the message is posted successfully, the command will return
successfully, even if the label could not be changed.
+
This option will not force the message to be posted if the command
fails because the user is not permitted to change the label.
--help::
-h::