diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt index fdb52731e0..513bc6e1ba 100644 --- a/Documentation/cmd-review.txt +++ b/Documentation/cmd-review.txt @@ -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::