write_file_v(): do not leave incomplete line at the end

gitster · gitster · commit e7ffa38c6e72 · 2015-08-25T12:48:39.000-07:00
All existing callers to this function use it to produce a text file
or an empty file, and a new callsite that mimick them must end their
payload with a LF.  If they forget to do so, the resulting file will
end with an incomplete line.

Teach write_file_v() to complete the incomplete line, if exists, so
that the callers do not have to.

With this, the caller-side fix in builtin/am.c becomes unnecessary.

Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/builtin/am.c b/builtin/am.c
@@ -199,19 +199,13 @@ static inline const char *am_path(const struct am_state *state, const char *path
 static int write_state_text(const struct am_state *state,
 			    const char *name, const char *string)
 {
-	const char *fmt;
-
-	if (*string && string[strlen(string) - 1] != '\n')
-		fmt = "%s\n";
-	else
-		fmt = "%s";
-	return write_file(am_path(state, name), fmt, string);
+	return write_file(am_path(state, name), "%s", string);
 }
 
 static int write_state_count(const struct am_state *state,
 			     const char *name, int value)
 {
-	return write_file(am_path(state, name), "%d\n", value);
+	return write_file(am_path(state, name), "%d", value);
 }
 
 static int write_state_bool(const struct am_state *state,
diff --git a/wrapper.c b/wrapper.c
@@ -632,6 +632,7 @@ static int write_file_v(const char *path, int fatal,
 		return -1;
 	}
 	strbuf_vaddf(&sb, fmt, params);
+	strbuf_complete_line(&sb);
 	if (write_in_full(fd, sb.buf, sb.len) != sb.len) {
 		int err = errno;
 		close(fd);

Original file line number	Diff line number	Diff line change
`@@ -199,19 +199,13 @@ static inline const char am_path(const struct am_state state, const char *path`
`199`	`199`	`static int write_state_text(const struct am_state *state,`
`200`	`200`	`const char name, const char string)`
`201`	`201`	`{`
`202`		`- const char *fmt;`
`203`		`-`
`204`		`- if (*string && string[strlen(string) - 1] != '\n')`
`205`		`- fmt = "%s\n";`
`206`		`- else`
`207`		`- fmt = "%s";`
`208`		`- return write_file(am_path(state, name), fmt, string);`
	`202`	`+ return write_file(am_path(state, name), "%s", string);`
`209`	`203`	`}`
`210`	`204`
`211`	`205`	`static int write_state_count(const struct am_state *state,`
`212`	`206`	`const char *name, int value)`
`213`	`207`	`{`
`214`		`- return write_file(am_path(state, name), "%d\n", value);`
	`208`	`+ return write_file(am_path(state, name), "%d", value);`
`215`	`209`	`}`
`216`	`210`
`217`	`211`	`static int write_state_bool(const struct am_state *state,`
Original file line number	Diff line number	Diff line change
`@@ -632,6 +632,7 @@ static int write_file_v(const char *path, int fatal,`
`632`	`632`	`return -1;`
`633`	`633`	`}`
`634`	`634`	`strbuf_vaddf(&sb, fmt, params);`
	`635`	`+ strbuf_complete_line(&sb);`
`635`	`636`	`if (write_in_full(fd, sb.buf, sb.len) != sb.len) {`
`636`	`637`	`int err = errno;`
`637`	`638`	`close(fd);`