SubmittingPatches: Document some extra tags used in commit messages
Document the meanings of the tags "Reported-by:", "Acked-by:", "Reviewed-by:" and "Tested-by:" clearly. Also mention that the user is free to use any custom tags. Helped-by: Jonathan Nieder <jrnieder@gmail.com> Liked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ramkumar Ramachandra committed
Oct 2, 2010 at 10:07 UTC
95b7a41a80e56e3df904a2080d0665565c231272
1 file changed
+15
-6
Documentation/SubmittingPatches
+15
-6
@@ -264,12 +264,21 @@ the change to its true author (see (2) above).
264
Also notice that a real name is used in the Signed-off-by: line. Please
265
don't hide your real name.
266
267
-Some people also put extra tags at the end.
268
-
269
-"Acked-by:" says that the patch was reviewed by the person who
270
-is more familiar with the issues and the area the patch attempts
271
-to modify. "Tested-by:" says the patch was tested by the person
272
-and found to have the desired effect.
267
+If you like, you can put extra tags at the end:
268
+
269
+1. "Reported-by:" is used to to credit someone who found the bug that
270
+ the patch attempts to fix.
271
+2. "Acked-by:" says that the person who is more familiar with the area
272
+ the patch attempts to modify liked the patch.
273
+3. "Reviewed-by:", unlike the other tags, can only be offered by the
274
+ reviewer and means that she is completely satisfied that the patch
275
+ is ready for application. It is usually offered only after a
276
+ detailed review.
277
+4. "Tested-by:" is used to indicate that the person applied the patch
278
+ and found it to have the desired effect.
279
+
280
+You can also create your own tag or use one that's in common usage
281
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
282
283
------------------------------------------------
284
An ideal patch flow