git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/5] verify_lock(): return 0/-1 rather than struct ref_lock *

From
Stefan Beller <sbeller@google.com>
Date
May 23, 2015, 00:09 UTC
Message-ID
<CAGZ79kZnpruF+DfO9WO2cT1796j_0XUU8E3qFAg1qoufdBz4Pg@mail.gmail.com>
In-Reply-To
<1432337697-29161-2-git-send-email-mhagger@alum.mit.edu>
On Fri, May 22, 2015 at 4:34 PM, Michael Haggerty <mhagger@alum.mit.edu> wrote:
Show 6 quoted lines
> Its return value wasn't conveying any extra information, but it made
> the reader wonder whether the ref_lock that it returned might be
> different than the one that was passed to it. So change the function
> to the traditional "return 0 on success or a negative value on error".
>
> Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Bonus points for the documentation!
Reviewed-by: Stefan Beller <sbeller@google.com>
Show 60 quoted lines
> ---
>  refs.c | 21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)
>
> diff --git a/refs.c b/refs.c
> index 97043fd..4432bc9 100644
> --- a/refs.c
> +++ b/refs.c
> @@ -2195,9 +2195,14 @@ static void unlock_ref(struct ref_lock *lock)
>         free(lock);
>  }
>
> -/* This function should make sure errno is meaningful on error */
> -static struct ref_lock *verify_lock(struct ref_lock *lock,
> -       const unsigned char *old_sha1, int mustexist)
> +/*
> + * Verify that the reference locked by lock has the value old_sha1.
> + * Fail if the reference doesn't exist and mustexist is set. Return 0
> + * on success or a negative value on error. This function should make
> + * sure errno is meaningful on error.
> + */
> +static int verify_lock(struct ref_lock *lock,
> +                      const unsigned char *old_sha1, int mustexist)
>  {
>         if (read_ref_full(lock->ref_name,
>                           mustexist ? RESOLVE_REF_READING : 0,
> @@ -2206,16 +2211,16 @@ static struct ref_lock *verify_lock(struct ref_lock *lock,
>                 error("Can't verify ref %s", lock->ref_name);
>                 unlock_ref(lock);
>                 errno = save_errno;
> -               return NULL;
> +               return -1;
>         }
>         if (hashcmp(lock->old_sha1, old_sha1)) {
>                 error("Ref %s is at %s but expected %s", lock->ref_name,
>                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
>                 unlock_ref(lock);
>                 errno = EBUSY;
> -               return NULL;
> +               return -1;
>         }
> -       return lock;
> +       return 0;
>  }
>
>  static int remove_empty_directories(const char *file)
> @@ -2445,7 +2450,9 @@ static struct ref_lock *lock_ref_sha1_basic(const char *refname,
>                         goto error_return;
>                 }
>         }
> -       return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
> +       if (old_sha1 && verify_lock(lock, old_sha1, mustexist))
> +               return NULL;
> +       return lock;
>
>   error_return:
>         unlock_ref(lock);
> --
> 2.1.4
>
Previous: Michael HaggertyNext: Michael Haggerty
Message 3 of 12 in “Fix verify_lock() to report errors via strbuf”
  1. 0/5 Fix verify_lock() to report errors via strbufMichael Haggerty, May 22, 2015
  2. 1/5 verify_lock(): return 0/-1 rather than struct ref_lock *Michael Haggerty, May 22, 2015
  3. Stefan BellerMay 23, 2015
  4. 2/5 verify_lock(): on errors, let the caller unlock the lockMichael Haggerty, May 22, 2015
  5. 3/5 verify_lock(): report errors via a strbufMichael Haggerty, May 22, 2015
  6. Junio C HamanoMay 27, 2015
  7. Michael HaggertyMay 27, 2015
  8. 4/5 verify_lock(): do not capitalize error messagesMichael Haggerty, May 22, 2015
  9. 5/5 ref_transaction_commit(): do not capitalize error messagesMichael Haggerty, May 22, 2015
  10. Stefan BellerMay 23, 2015
  11. Michael HaggertyMay 27, 2015
  12. Junio C HamanoMay 27, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.