[PATCH v9 3/7] refs: new public ref function: safe_create_reflog

2015-07-21 Thread David Turner
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 dtur...@twopensource.com
---
 builtin/checkout.c | 14 +-
 refs.c | 24 
 refs.h |  2 +-
 3 files changed, 26 insertions(+), 14 deletions(-)

diff --git a/builtin/checkout.c b/builtin/checkout.c
index beea1eb..3165553 100644
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -620,24 +620,20 @@ static void update_refs_for_switch(const struct 
checkout_opts *opts,
if (opts-new_branch) {
if (opts-new_orphan_branch) {
if (opts-new_branch_log  !log_all_ref_updates) {
-   int temp;
-   struct strbuf log_file = STRBUF_INIT;
int ret;
-   const char *ref_name;
+   char *refname;
struct strbuf err = STRBUF_INIT;
 
-   ref_name = mkpath(refs/heads/%s, 
opts-new_orphan_branch);
-   temp = log_all_ref_updates;
-   log_all_ref_updates = 1;
-   ret = log_ref_setup(ref_name, log_file, err);
-   log_all_ref_updates = temp;
-   strbuf_release(log_file);
+   refname = mkpathdup(refs/heads/%s, 
opts-new_orphan_branch);
+   ret = safe_create_reflog(refname, err, 1);
+   free(refname);
if (ret) {
fprintf(stderr, _(Can not do reflog 
for '%s': %s\n),
opts-new_orphan_branch, 
err.buf);
strbuf_release(err);
return;
}
+   strbuf_release(err);
}
}
else
diff --git a/refs.c b/refs.c
index 2efa2dc..3277768 100644
--- a/refs.c
+++ b/refs.c
@@ -3128,8 +3128,13 @@ static int should_autocreate_reflog(const char *refname)
!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;
char *logfile;
@@ -3138,7 +3143,7 @@ int log_ref_setup(const char *refname, struct strbuf 
*sb_logfile, struct strbuf
logfile = sb_logfile-buf;
/* make sure the rest of the function can't change logfile */
sb_logfile = NULL;
-   if (should_autocreate_reflog(refname)) {
+   if (force_create || should_autocreate_reflog(refname)) {
if (safe_create_leading_directories(logfile)  0) {
strbuf_addf(err, unable to create directory for %s: 
%s, logfile, strerror(errno));
@@ -3173,6 +3178,17 @@ int log_ref_setup(const char *refname, struct strbuf 
*sb_logfile, struct strbuf
return 0;
 }
 
+
+int safe_create_reflog(const char *refname, struct strbuf *err, int 
force_create)
+{
+   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,
const unsigned char *new_sha1,
const char *committer, const char *msg)
@@ -3209,7 +3225,7 @@ static int log_ref_write_1(const char *refname, const 
unsigned char *old_sha1,
if (log_all_ref_updates  0)
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)
return result;
diff --git a/refs.h b/refs.h
index debdefc..3b90e16 100644
--- a/refs.h
+++ b/refs.h
@@ -228,7 +228,7 @@ int pack_refs(unsigned int flags);
 /*
  * 

Re: [PATCH v9 3/7] refs: new public ref function: safe_create_reflog

2015-07-21 Thread Michael Haggerty
On 07/21/2015 08:45 AM, David Turner wrote:
 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 dtur...@twopensource.com
 ---
  builtin/checkout.c | 14 +-
  refs.c | 24 
  refs.h |  2 +-
  3 files changed, 26 insertions(+), 14 deletions(-)
 
 [...]
 diff --git a/refs.c b/refs.c
 index 2efa2dc..3277768 100644
 --- a/refs.c
 +++ b/refs.c
 @@ -3128,8 +3128,13 @@ static int should_autocreate_reflog(const char 
 *refname)
   !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;
   char *logfile;
 @@ -3138,7 +3143,7 @@ int log_ref_setup(const char *refname, struct strbuf 
 *sb_logfile, struct strbuf
   logfile = sb_logfile-buf;
   /* make sure the rest of the function can't change logfile */
   sb_logfile = NULL;
 - if (should_autocreate_reflog(refname)) {
 + if (force_create || should_autocreate_reflog(refname)) {
   if (safe_create_leading_directories(logfile)  0) {
   strbuf_addf(err, unable to create directory for %s: 
   %s, logfile, strerror(errno));

I think usually the strbuf *err parameter is the last one in our APIs.
I noticed this when reviewing patch 5/7, where there is a similar flags
argument that comes *before* err. Consistency would suggest that
force_create come before err.

Michael

-- 
Michael Haggerty
mhag...@alum.mit.edu

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html