write_file(): drop "fatal" parameter

All callers except three passed 1 for the "fatal" parameter to ask
this function to die upon error, but to a casual reader of the code,
it was not all obvious what that 1 meant.  Instead, split the
function into two based on a common write_file_v() that takes the
flag, introduce write_file_gently() as a new way to attempt creating
a file without dying on error, and make three callers to call it.

Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/am.c b/builtin/am.c
index f0a046bdc05fa91e6d21016e6a0b246149fe3802..9c576779c36caa41edf20d7dd94a51893b00206c 100644 (file)
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -205,13 +205,13 @@ static int write_state_text(const struct am_state *state,
                fmt = "%s\n";
        else
                fmt = "%s";
-       return write_file(am_path(state, name), 1, fmt, string);
+       return write_file(am_path(state, name), fmt, string);
 }
 
 static int write_state_count(const struct am_state *state,
                             const char *name, int value)
 {
-       return write_file(am_path(state, name), 1, "%d\n", value);
+       return write_file(am_path(state, name), "%d\n", value);
 }
 
 static int write_state_bool(const struct am_state *state,

diff --git a/builtin/branch.c b/builtin/branch.c
index 58aa84f1e85212772d15175679e95263eae75123..ff05869949b7c5c4cd0034e7a0ba54e2adeae6b4 100644 (file)
--- a/builtin/branch.c
+++ b/builtin/branch.c
@@ -776,7 +776,7 @@ static int edit_branch_description(const char *branch_name)
                    "  %s\n"
                    "Lines starting with '%c' will be stripped.\n",
                    branch_name, comment_line_char);
-       if (write_file(git_path(edit_description), 0, "%s", buf.buf)) {
+       if (write_file_gently(git_path(edit_description), "%s", buf.buf)) {
                strbuf_release(&buf);
                return error(_("could not write branch description template: %s"),
                             strerror(errno));

diff --git a/builtin/init-db.c b/builtin/init-db.c
index 49df78d2624d58a29173e4e3a881af0b0e37b7c5..bfe1d08234ddeae1b36d2dc4447a933123cbda1c 100644 (file)
--- a/builtin/init-db.c
+++ b/builtin/init-db.c
@@ -378,7 +378,7 @@ static void separate_git_dir(const char *git_dir)
                        die_errno(_("unable to move %s to %s"), src, git_dir);
        }
 
-       write_file(git_link, 1, "gitdir: %s\n", git_dir);
+       write_file(git_link, "gitdir: %s\n", git_dir);
 }
 
 int init_db(const char *template_dir, unsigned int flags)

diff --git a/builtin/worktree.c b/builtin/worktree.c
index 6a264ee749221cd6c6bf98ce68790bdec3dd82c5..368502d8371474045e0e39541077795c1deee091 100644 (file)
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -213,7 +213,7 @@ static int add_worktree(const char *path, const char **child_argv)
         * after the preparation is over.
         */
        strbuf_addf(&sb, "%s/locked", sb_repo.buf);
-       write_file(sb.buf, 1, "initializing\n");
+       write_file(sb.buf, "initializing\n");
 
        strbuf_addf(&sb_git, "%s/.git", path);
        if (safe_create_leading_directories_const(sb_git.buf))
@@ -223,8 +223,8 @@ static int add_worktree(const char *path, const char **child_argv)
 
        strbuf_reset(&sb);
        strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
-       write_file(sb.buf, 1, "%s\n", real_path(sb_git.buf));
-       write_file(sb_git.buf, 1, "gitdir: %s/worktrees/%s\n",
+       write_file(sb.buf, "%s\n", real_path(sb_git.buf));
+       write_file(sb_git.buf, "gitdir: %s/worktrees/%s\n",
                   real_path(get_git_common_dir()), name);
        /*
         * This is to keep resolve_ref() happy. We need a valid HEAD
@@ -241,10 +241,10 @@ static int add_worktree(const char *path, const char **child_argv)
                die(_("unable to resolve HEAD"));
        strbuf_reset(&sb);
        strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
-       write_file(sb.buf, 1, "%s\n", sha1_to_hex(rev));
+       write_file(sb.buf, "%s\n", sha1_to_hex(rev));
        strbuf_reset(&sb);
        strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
-       write_file(sb.buf, 1, "../..\n");
+       write_file(sb.buf, "../..\n");
 
        fprintf_ln(stderr, _("Enter %s (identifier %s)"), path, name);
 

diff --git a/cache.h b/cache.h
index 6bb7119032ce95932f011bfd7c58e34e3b57af8a..3f79e6b61651f83b44a0e987fd7692e953a57664 100644 (file)
--- a/cache.h
+++ b/cache.h
@@ -1539,8 +1539,9 @@ static inline ssize_t write_str_in_full(int fd, const char *str)
 {
        return write_in_full(fd, str, strlen(str));
 }
-__attribute__((format (printf, 3, 4)))
-extern int write_file(const char *path, int fatal, const char *fmt, ...);
+
+extern int write_file(const char *path, const char *fmt, ...);
+extern int write_file_gently(const char *path, const char *fmt, ...);
 
 /* pager.c */
 extern void setup_pager(void);

diff --git a/daemon.c b/daemon.c
index d3d3e433e370e7a21dad829b5861172e92a6d72f..91545090a72e45e16626d1c54e30e5f507c28ce3 100644 (file)
--- a/daemon.c
+++ b/daemon.c
@@ -1376,7 +1376,7 @@ int main(int argc, char **argv)
                sanitize_stdfds();
 
        if (pid_file)
-               write_file(pid_file, 1, "%"PRIuMAX"\n", (uintmax_t) getpid());
+               write_file(pid_file, "%"PRIuMAX"\n", (uintmax_t) getpid());
 
        /* prepare argv for serving-processes */
        cld_argv = xmalloc(sizeof (char *) * (argc + 2));

diff --git a/setup.c b/setup.c
index 5f9f07dcdb059ad6aeac8d90ee18aedf56a8f85e..feb85651ef4f9808505ae96b5fd954fd84642403 100644 (file)
--- a/setup.c
+++ b/setup.c
@@ -404,7 +404,7 @@ static void update_linked_gitdir(const char *gitfile, const char *gitdir)
 
        strbuf_addf(&path, "%s/gitfile", gitdir);
        if (stat(path.buf, &st) || st.st_mtime + 24 * 3600 < time(NULL))
-               write_file(path.buf, 0, "%s\n", gitfile);
+               write_file_gently(path.buf, "%s\n", gitfile);
        strbuf_release(&path);
 }
 

diff --git a/submodule.c b/submodule.c
index 700bbf4fcb4cd93b79304d934bed8901c63a853a..5519f11fdb1e078b5cebb3f38f295b0d2db29f92 100644 (file)
--- a/submodule.c
+++ b/submodule.c
@@ -1103,7 +1103,7 @@ void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir)
 
        /* Update gitfile */
        strbuf_addf(&file_name, "%s/.git", work_tree);
-       write_file(file_name.buf, 1, "gitdir: %s\n",
+       write_file(file_name.buf, "gitdir: %s\n",
                   relative_path(git_dir, real_work_tree, &rel_path));
 
        /* Update core.worktree setting */

diff --git a/transport.c b/transport.c
index 40692f8ae8aba65001bdee1300e525def1e1870d..025439435629ad45c48840112a6ba672ffc39655 100644 (file)
--- a/transport.c
+++ b/transport.c
@@ -291,7 +291,7 @@ static int write_one_ref(const char *name, const struct object_id *oid,
 
        strbuf_addstr(buf, name);
        if (safe_create_leading_directories(buf->buf) ||
-           write_file(buf->buf, 0, "%s\n", oid_to_hex(oid)))
+           write_file_gently(buf->buf, "%s\n", oid_to_hex(oid)))
                return error("problems writing temporary file %s: %s",
                             buf->buf, strerror(errno));
        strbuf_setlen(buf, len);

diff --git a/wrapper.c b/wrapper.c
index e4514634313c44354190e0c7e08a2b501aa0b098..8c8925b72a804395bfdec30108beb5dc9150ee9d 100644 (file)
--- a/wrapper.c
+++ b/wrapper.c
@@ -621,19 +621,17 @@ char *xgetcwd(void)
        return strbuf_detach(&sb, NULL);
 }
 
-int write_file(const char *path, int fatal, const char *fmt, ...)
+static int write_file_v(const char *path, int fatal,
+                       const char *fmt, va_list params)
 {
        struct strbuf sb = STRBUF_INIT;
-       va_list params;
        int fd = open(path, O_RDWR | O_CREAT | O_TRUNC, 0666);
        if (fd < 0) {
                if (fatal)
                        die_errno(_("could not open %s for writing"), path);
                return -1;
        }
-       va_start(params, fmt);
        strbuf_vaddf(&sb, fmt, params);
-       va_end(params);
        if (write_in_full(fd, sb.buf, sb.len) != sb.len) {
                int err = errno;
                close(fd);
@@ -652,6 +650,28 @@ int write_file(const char *path, int fatal, const char *fmt, ...)
        return 0;
 }
 
+int write_file(const char *path, const char *fmt, ...)
+{
+       int status;
+       va_list params;
+
+       va_start(params, fmt);
+       status = write_file_v(path, 1, fmt, params);
+       va_end(params);
+       return status;
+}
+
+int write_file_gently(const char *path, const char *fmt, ...)
+{
+       int status;
+       va_list params;
+
+       va_start(params, fmt);
+       status = write_file_v(path, 0, fmt, params);
+       va_end(params);
+       return status;
+}
+
 void sleep_millisec(int millisec)
 {
        poll(NULL, 0, millisec);