refs: new public ref function: safe_create_reflog

The safe_create_reflog function creates a reflog, if it does not
already exist.

The log_ref_setup function becomes private and gains a force_create
parameter to force the creation of a reflog even if log_all_ref_updates
is false or the refname is not one of the special refnames.

The new parameter also reduces the need to store, modify, and restore
the log_all_ref_updates global before reflog creation.

In a moment, we will use this to add reflog creation commands to
git-reflog.

Signed-off-by: David Turner <dturner@twopensource.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
David Turner 2015-07-21 17:04:52 -04:00 committed by Junio C Hamano
parent 4e2bef57c9
commit abd0cd3a30
3 changed files with 26 additions and 14 deletions

View File

@ -619,24 +619,20 @@ static void update_refs_for_switch(const struct checkout_opts *opts,
if (opts->new_branch) { if (opts->new_branch) {
if (opts->new_orphan_branch) { if (opts->new_orphan_branch) {
if (opts->new_branch_log && !log_all_ref_updates) { if (opts->new_branch_log && !log_all_ref_updates) {
int temp;
struct strbuf log_file = STRBUF_INIT;
int ret; int ret;
const char *ref_name; char *refname;
struct strbuf err = STRBUF_INIT; struct strbuf err = STRBUF_INIT;
ref_name = mkpath("refs/heads/%s", opts->new_orphan_branch); refname = mkpathdup("refs/heads/%s", opts->new_orphan_branch);
temp = log_all_ref_updates; ret = safe_create_reflog(refname, 1, &err);
log_all_ref_updates = 1; free(refname);
ret = log_ref_setup(ref_name, &log_file, &err);
log_all_ref_updates = temp;
strbuf_release(&log_file);
if (ret) { if (ret) {
fprintf(stderr, _("Can not do reflog for '%s': %s\n"), fprintf(stderr, _("Can not do reflog for '%s': %s\n"),
opts->new_orphan_branch, err.buf); opts->new_orphan_branch, err.buf);
strbuf_release(&err); strbuf_release(&err);
return; return;
} }
strbuf_release(&err);
} }
} }
else else

24
refs.c
View File

@ -3063,8 +3063,13 @@ static int should_autocreate_reflog(const char *refname)
!strcmp(refname, "HEAD"); !strcmp(refname, "HEAD");
} }
/* This function will fill in *err and return -1 on failure */ /*
int log_ref_setup(const char *refname, struct strbuf *sb_logfile, struct strbuf *err) * Create a reflog for a ref. If force_create = 0, the reflog will
* only be created for certain refs (those for which
* should_autocreate_reflog returns non-zero. Otherwise, create it
* regardless of the ref name. Fill in *err and return -1 on failure.
*/
static int log_ref_setup(const char *refname, struct strbuf *sb_logfile, struct strbuf *err, int force_create)
{ {
int logfd, oflags = O_APPEND | O_WRONLY; int logfd, oflags = O_APPEND | O_WRONLY;
char *logfile; char *logfile;
@ -3073,7 +3078,7 @@ int log_ref_setup(const char *refname, struct strbuf *sb_logfile, struct strbuf
logfile = sb_logfile->buf; logfile = sb_logfile->buf;
/* make sure the rest of the function can't change "logfile" */ /* make sure the rest of the function can't change "logfile" */
sb_logfile = NULL; sb_logfile = NULL;
if (should_autocreate_reflog(refname)) { if (force_create || should_autocreate_reflog(refname)) {
if (safe_create_leading_directories(logfile) < 0) { if (safe_create_leading_directories(logfile) < 0) {
strbuf_addf(err, "unable to create directory for %s: " strbuf_addf(err, "unable to create directory for %s: "
"%s", logfile, strerror(errno)); "%s", logfile, strerror(errno));
@ -3108,6 +3113,17 @@ int log_ref_setup(const char *refname, struct strbuf *sb_logfile, struct strbuf
return 0; return 0;
} }
int safe_create_reflog(const char *refname, int force_create, struct strbuf *err)
{
int ret;
struct strbuf sb = STRBUF_INIT;
ret = log_ref_setup(refname, &sb, err, force_create);
strbuf_release(&sb);
return ret;
}
static int log_ref_write_fd(int fd, const unsigned char *old_sha1, static int log_ref_write_fd(int fd, const unsigned char *old_sha1,
const unsigned char *new_sha1, const unsigned char *new_sha1,
const char *committer, const char *msg) const char *committer, const char *msg)
@ -3144,7 +3160,7 @@ static int log_ref_write_1(const char *refname, const unsigned char *old_sha1,
if (log_all_ref_updates < 0) if (log_all_ref_updates < 0)
log_all_ref_updates = !is_bare_repository(); log_all_ref_updates = !is_bare_repository();
result = log_ref_setup(refname, sb_log_file, err); result = log_ref_setup(refname, sb_log_file, err, 0);
if (result) if (result)
return result; return result;

2
refs.h
View File

@ -191,7 +191,7 @@ extern int peel_ref(const char *refname, unsigned char *sha1);
/* /*
* Setup reflog before using. Fill in err and return -1 on failure. * Setup reflog before using. Fill in err and return -1 on failure.
*/ */
int log_ref_setup(const char *refname, struct strbuf *logfile, struct strbuf *err); int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
/** Reads log for the value of ref during at_time. **/ /** Reads log for the value of ref during at_time. **/
extern int read_ref_at(const char *refname, unsigned int flags, extern int read_ref_at(const char *refname, unsigned int flags,