commit a40bb124fa647b45be1288f079b45e8a9311ee8e
author Edwin Kempin <ekempin@google.com> Fri Jan 17 09:35:44 2020 +0100
committer Edwin Kempin <ekempin@google.com> Fri Jan 17 15:19:46 2020 +0100
tree c5d8b1bacec1ad8c2938eddaebcb1359a213a7d9
parent ea265b14db493d68d70d04c829a5a14b01be43f9

Include patch set number into message when setting description for patch set

When a description for a patch set is set/removed, a change message
with the new/old description is added to the change. However it doesn't
say for which patch set the description was set/removed, which makes the
message not very useful, as you cannot distinguish between messages for
different patch sets.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Iaa43c1897a236592c756535346689971a478dc96

java/com/google/gerrit/server/restapi/change/PutDescription.java

diff --git a/java/com/google/gerrit/server/restapi/change/PutDescription.java b/java/com/google/gerrit/server/restapi/change/PutDescription.java
index d84ab3e..f442a42 100644
--- a/java/com/google/gerrit/server/restapi/change/PutDescription.java
+++ b/java/com/google/gerrit/server/restapi/change/PutDescription.java
@@ -87,17 +87,21 @@
       if (oldDescription.equals(newDescription)) {
         return false;
       }
-      String summary;
-      if (oldDescription.isEmpty()) {
-        summary = "Description set to \"" + newDescription + "\"";
-      } else if (newDescription.isEmpty()) {
-        summary = "Description \"" + oldDescription + "\" removed";
-      } else {
-        summary = "Description changed to \"" + newDescription + "\"";
-      }
-
       update.setPsDescription(newDescription);
 
+      String summary;
+      if (oldDescription.isEmpty()) {
+        summary =
+            String.format("Description of patch set %d set to \"%s\"", psId.get(), newDescription);
+      } else if (newDescription.isEmpty()) {
+        summary =
+            String.format(
+                "Description \"%s\" removed from patch set %d", oldDescription, psId.get());
+      } else {
+        summary =
+            String.format(
+                "Description of patch set %d changed to \"%s\"", psId.get(), newDescription);
+      }
       ChangeMessage cmsg =
           ChangeMessagesUtil.newMessage(
               psId, ctx.getUser(), ctx.getWhen(), summary, ChangeMessagesUtil.TAG_SET_DESCRIPTION);

javatests/com/google/gerrit/acceptance/api/revision/RevisionIT.java

diff --git a/javatests/com/google/gerrit/acceptance/api/revision/RevisionIT.java b/javatests/com/google/gerrit/acceptance/api/revision/RevisionIT.java
index d29f1cd..e6b2190 100644
--- a/javatests/com/google/gerrit/acceptance/api/revision/RevisionIT.java
+++ b/javatests/com/google/gerrit/acceptance/api/revision/RevisionIT.java
@@ -1325,19 +1325,19 @@
     gApi.changes().id(r.getChangeId()).revision(r.getCommit().name()).description("foo");
     assertDescription(r, "foo");
     assertThat(Iterables.getLast(gApi.changes().id(r.getChangeId()).get().messages).message)
-        .isEqualTo("Description set to \"foo\"");
+        .isEqualTo("Description of patch set 1 set to \"foo\"");
 
     // update description
     gApi.changes().id(r.getChangeId()).revision(r.getCommit().name()).description("bar");
     assertDescription(r, "bar");
     assertThat(Iterables.getLast(gApi.changes().id(r.getChangeId()).get().messages).message)
-        .isEqualTo("Description changed to \"bar\"");
+        .isEqualTo("Description of patch set 1 changed to \"bar\"");
 
     // remove description
     gApi.changes().id(r.getChangeId()).revision(r.getCommit().name()).description("");
     assertDescription(r, "");
     assertThat(Iterables.getLast(gApi.changes().id(r.getChangeId()).get().messages).message)
-        .isEqualTo("Description \"bar\" removed");
+        .isEqualTo("Description \"bar\" removed from patch set 1");
   }
 
   @Test