log-tree: fix confusing comment

peff · gitster · commit 8715227df650 · 2009-07-01T11:16:54.000-07:00
This comment mentions the case where use_terminator is set,
but this case is not handled at all by this chunk of code.

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/log-tree.c b/log-tree.c
@@ -321,7 +321,8 @@ void show_log(struct rev_info *opt)
 	}
 
 	/*
-	 * If use_terminator is set, add a newline at the end of the entry.
+	 * If use_terminator is set, we already handled any record termination
+	 * at the end of the last record.
 	 * Otherwise, add a diffopt.line_termination character before all
 	 * entries but the first.  (IOW, as a separator between entries)
 	 */

Original file line number	Diff line number	Diff line change
`@@ -321,7 +321,8 @@ void show_log(struct rev_info *opt)`
`321`	`321`	`}`
`322`	`322`
`323`	`323`	`/*`
`324`		`- * If use_terminator is set, add a newline at the end of the entry.`
	`324`	`+ * If use_terminator is set, we already handled any record termination`
	`325`	`+ * at the end of the last record.`
`325`	`326`	`* Otherwise, add a diffopt.line_termination character before all`
`326`	`327`	`* entries but the first. (IOW, as a separator between entries)`
`327`	`328`	`*/`