opendev/gerrit
Code Issues Proposed changes

ChangeStatus: Clarify that an ABANDONED change can be restored

Browse Source 
Clarify in the comments that an ABANDONED change can be moved to NEW
when the Restore action is used.

Also mention that currently DRAFT changes cannot be abandoned.

Change-Id: I141d9f29bb06ce8bdbc4a0cfba89efc8f9b4f579
This commit is contained in:
Michael Zhou
2016-03-24 22:07:39 -04:00
parent 249b0c8cad
commit 7426ba9047
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/client/ChangeStatus.java
View File

@@ -42,12 +42,12 @@ public enum ChangeStatus {
* the uploader publishes the change, it becomes a NEW change.
* Publishing is a one-way action, a change cannot return to DRAFT status.
* Draft changes are only visible to the uploader and those explicitly
* added as reviewers.
* added as reviewers. Note that currently draft changes cannot be abandoned.
*
* <p>
* Changes in the DRAFT state can be moved to:
* <ul>
* <li>{@link #NEW} - when the change is published, it becomes a new change;
* <li>{@link #NEW} - when the change is published, it becomes a new change.
* </ul>
*/
DRAFT,
@@ -69,6 +69,12 @@ public enum ChangeStatus {
* Once a change has been abandoned, it cannot be further modified by adding
* a replacement patch set, and it cannot be merged. Draft comments however
* may be published, permitting reviewers to send constructive feedback.
*
* <p>
* Changes in the ABANDONED state can be moved to:
* <ul>
* <li>{@link #NEW} - when the Restore action is used.
* </ul>
*/
ABANDONED
}
}