Re: [PATCH v8 10/44] refs.c: change ref_transaction_update() to do error checking and return status
On Thu, May 15, 2014 at 12:34 PM, Jonathan Nieder wrote:
> Ronnie Sahlberg wrote:
>
>> Update ref_transaction_update() do some basic error checking and return
>> non-zero on error. Update all callers to check ref_transaction_update() for
>> error. There are currently no conditions in _update that will return error
>> but
>> there will be in the future.
>
> Probably worth passing a 'struct strbuf *err' argument. Then callers
> can do
>
> die("%s", err.buf);
>
Done.
> and the error message can say which ref and whether we were trying to
> create a ref, or delete one, or whatever.
>
>> --- a/builtin/update-ref.c
>> +++ b/builtin/update-ref.c
>> @@ -197,8 +197,9 @@ static const char *parse_cmd_update(struct strbuf
>> *input, const char *next)
>> if (*next != line_termination)
>> die("update %s: extra input: %s", refname, next);
>>
>> - ref_transaction_update(transaction, refname, new_sha1, old_sha1,
>> -update_flags, have_old);
>> + if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
>> +update_flags, have_old))
>> + die("update %s: failed", refname);
>
> This could say
>
> die("update %s: %s", refname, err.buf);
Done.
>
> to give context about which command it was trying to execute.
>
> [...]
>> @@ -286,8 +287,9 @@ static const char *parse_cmd_verify(struct strbuf
>> *input, const char *next)
>> if (*next != line_termination)
>> die("verify %s: extra input: %s", refname, next);
>>
>> - ref_transaction_update(transaction, refname, new_sha1, old_sha1,
>> -update_flags, have_old);
>> + if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
>> +update_flags, have_old))
>> + die("failed transaction update for %s", refname);
>
> And this could say
>
> die("verify %s: %s", refname, err.buf);
Done.
>
> [...]
>> --- a/refs.h
>> +++ b/refs.h
>> @@ -242,12 +242,15 @@ void ref_transaction_rollback(struct ref_transaction
>> *transaction);
>> * be deleted. If have_old is true, then old_sha1 holds the value
>> * that the reference should have had before the update, or zeros if
>> * it must not have existed beforehand.
>> + * Function returns 0 on success and non-zero on failure. A failure to
>> update
>> + * means that the transaction as a whole has failed and will need to be
>> + * rolled back.
>> + */
>
> Thanks for this documentation.
--
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
Re: [PATCH v8 10/44] refs.c: change ref_transaction_update() to do error checking and return status
Ronnie Sahlberg wrote:
> Update ref_transaction_update() do some basic error checking and return
> non-zero on error. Update all callers to check ref_transaction_update() for
> error. There are currently no conditions in _update that will return error but
> there will be in the future.
Probably worth passing a 'struct strbuf *err' argument. Then callers
can do
die("%s", err.buf);
and the error message can say which ref and whether we were trying to
create a ref, or delete one, or whatever.
> --- a/builtin/update-ref.c
> +++ b/builtin/update-ref.c
> @@ -197,8 +197,9 @@ static const char *parse_cmd_update(struct strbuf *input,
> const char *next)
> if (*next != line_termination)
> die("update %s: extra input: %s", refname, next);
>
> - ref_transaction_update(transaction, refname, new_sha1, old_sha1,
> -update_flags, have_old);
> + if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
> +update_flags, have_old))
> + die("update %s: failed", refname);
This could say
die("update %s: %s", refname, err.buf);
to give context about which command it was trying to execute.
[...]
> @@ -286,8 +287,9 @@ static const char *parse_cmd_verify(struct strbuf *input,
> const char *next)
> if (*next != line_termination)
> die("verify %s: extra input: %s", refname, next);
>
> - ref_transaction_update(transaction, refname, new_sha1, old_sha1,
> -update_flags, have_old);
> + if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
> +update_flags, have_old))
> + die("failed transaction update for %s", refname);
And this could say
die("verify %s: %s", refname, err.buf);
[...]
> --- a/refs.h
> +++ b/refs.h
> @@ -242,12 +242,15 @@ void ref_transaction_rollback(struct ref_transaction
> *transaction);
> * be deleted. If have_old is true, then old_sha1 holds the value
> * that the reference should have had before the update, or zeros if
> * it must not have existed beforehand.
> + * Function returns 0 on success and non-zero on failure. A failure to update
> + * means that the transaction as a whole has failed and will need to be
> + * rolled back.
> + */
Thanks for this documentation.
--
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
[PATCH v8 10/44] refs.c: change ref_transaction_update() to do error checking and return status
Update ref_transaction_update() do some basic error checking and return
non-zero on error. Update all callers to check ref_transaction_update() for
error. There are currently no conditions in _update that will return error but
there will be in the future.
Also check for BUGs during update and die(BUG:...) if we are calling
_update with have_old but the old_sha1 pointer is NULL.
Signed-off-by: Ronnie Sahlberg
---
builtin/update-ref.c | 10 ++
refs.c | 9 +++--
refs.h | 13 -
3 files changed, 21 insertions(+), 11 deletions(-)
diff --git a/builtin/update-ref.c b/builtin/update-ref.c
index 2bef2a0..59c4d6b 100644
--- a/builtin/update-ref.c
+++ b/builtin/update-ref.c
@@ -197,8 +197,9 @@ static const char *parse_cmd_update(struct strbuf *input,
const char *next)
if (*next != line_termination)
die("update %s: extra input: %s", refname, next);
- ref_transaction_update(transaction, refname, new_sha1, old_sha1,
- update_flags, have_old);
+ if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
+ update_flags, have_old))
+ die("update %s: failed", refname);
update_flags = 0;
free(refname);
@@ -286,8 +287,9 @@ static const char *parse_cmd_verify(struct strbuf *input,
const char *next)
if (*next != line_termination)
die("verify %s: extra input: %s", refname, next);
- ref_transaction_update(transaction, refname, new_sha1, old_sha1,
- update_flags, have_old);
+ if (ref_transaction_update(transaction, refname, new_sha1, old_sha1,
+ update_flags, have_old))
+ die("failed transaction update for %s", refname);
update_flags = 0;
free(refname);
diff --git a/refs.c b/refs.c
index bc21060..e8c2345 100644
--- a/refs.c
+++ b/refs.c
@@ -3353,19 +3353,24 @@ static struct ref_update *add_update(struct
ref_transaction *transaction,
return update;
}
-void ref_transaction_update(struct ref_transaction *transaction,
+int ref_transaction_update(struct ref_transaction *transaction,
const char *refname,
const unsigned char *new_sha1,
const unsigned char *old_sha1,
int flags, int have_old)
{
- struct ref_update *update = add_update(transaction, refname);
+ struct ref_update *update;
+
+ if (have_old && !old_sha1)
+ die("BUG: have_old is true but old_sha1 is NULL");
+ update = add_update(transaction, refname);
hashcpy(update->new_sha1, new_sha1);
update->flags = flags;
update->have_old = have_old;
if (have_old)
hashcpy(update->old_sha1, old_sha1);
+ return 0;
}
void ref_transaction_create(struct ref_transaction *transaction,
diff --git a/refs.h b/refs.h
index 555ee59..fd8d731 100644
--- a/refs.h
+++ b/refs.h
@@ -242,12 +242,15 @@ void ref_transaction_rollback(struct ref_transaction
*transaction);
* be deleted. If have_old is true, then old_sha1 holds the value
* that the reference should have had before the update, or zeros if
* it must not have existed beforehand.
+ * Function returns 0 on success and non-zero on failure. A failure to update
+ * means that the transaction as a whole has failed and will need to be
+ * rolled back.
*/
-void ref_transaction_update(struct ref_transaction *transaction,
- const char *refname,
- const unsigned char *new_sha1,
- const unsigned char *old_sha1,
- int flags, int have_old);
+int ref_transaction_update(struct ref_transaction *transaction,
+ const char *refname,
+ const unsigned char *new_sha1,
+ const unsigned char *old_sha1,
+ int flags, int have_old);
/*
* Add a reference creation to transaction. new_sha1 is the value
--
2.0.0.rc3.477.g0f8edf7
--
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
