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

[PATCH v21 05/19] refs.c: add a strbuf argument to ref_transaction_commit for error logging

From
Ronnie Sahlberg <sahlberg@google.com>
Date
Jul 14, 2014, 20:58 UTC
Message-ID
<1405371541-32121-6-git-send-email-sahlberg@google.com>
In-Reply-To
<1405371541-32121-1-git-send-email-sahlberg@google.com>

Add a strbuf argument to _commit so that we can pass an error string back to the caller. So that we can do error logging from the caller instead of from _commit.

Longer term plan is to first convert all callers to use onerr==QUIET_ON_ERR and craft any log messages from the callers themselves and finally remove the onerr argument completely.

Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Reviewed-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
---
 builtin/update-ref.c | 2 +-
 refs.c               | 6 +++++-
 refs.h               | 5 ++++-
 3 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/builtin/update-ref.c b/builtin/update-ref.c
index 1fd7a89..22617af 100644
--- a/builtin/update-ref.c
+++ b/builtin/update-ref.c
@@ -367,7 +367,7 @@ int cmd_update_ref(int argc, const char **argv, const char *prefix)
 		if (end_null)
 			line_termination = '\0';
 		update_refs_stdin();
-		ret = ref_transaction_commit(transaction, msg,
+		ret = ref_transaction_commit(transaction, msg, NULL,
 					     UPDATE_REFS_DIE_ON_ERR);
 		ref_transaction_free(transaction);
 		return ret;
diff --git a/refs.c b/refs.c
index 1d6dece..db05602 100644
--- a/refs.c
+++ b/refs.c
@@ -3444,7 +3444,8 @@ static int ref_update_reject_duplicates(struct ref_update **updates, int n,
 }
 
 int ref_transaction_commit(struct ref_transaction *transaction,
-			   const char *msg, enum action_on_err onerr)
+			   const char *msg, struct strbuf *err,
+			   enum action_on_err onerr)
 {
 	int ret = 0, delnum = 0, i;
 	const char **delnames;
@@ -3473,6 +3474,9 @@ int ref_transaction_commit(struct ref_transaction *transaction,
 					       update->flags,
 					       &update->type, onerr);
 		if (!update->lock) {
+			if (err)
+				strbuf_addf(err, "Cannot lock the ref '%s'.",
+					    update->refname);
 			ret = 1;
 			goto cleanup;
 		}
diff --git a/refs.h b/refs.h
index 8c7f9c4..09d3564 100644
--- a/refs.h
+++ b/refs.h
@@ -269,9 +269,12 @@ void ref_transaction_delete(struct ref_transaction *transaction,
  * Commit all of the changes that have been queued in transaction, as
  * atomically as possible.  Return a nonzero value if there is a
  * problem.
+ * If err is non-NULL we will add an error string to it to explain why
+ * the transaction failed. The string does not end in newline.
  */
 int ref_transaction_commit(struct ref_transaction *transaction,
-			   const char *msg, enum action_on_err onerr);
+			   const char *msg, struct strbuf *err,
+			   enum action_on_err onerr);
 
 /*
  * Free an existing transaction and all associated data.

-- 
2.0.1.546.gf603308
Previous: Ronnie SahlbergNext: Ronnie Sahlberg
Message 6 of 20 in “Use ref transactions”
  1. 00/19 Use ref transactionsRonnie Sahlberg, Jul 14, 2014
  2. 01/19 refs.c: remove ref_transaction_rollbackRonnie Sahlberg, Jul 14, 2014
  3. 02/19 refs.c: ref_transaction_commit should not free the transactionRonnie Sahlberg, Jul 14, 2014
  4. 03/19 refs.c: constify the sha arguments for ref_transaction_create|delete|updateRonnie Sahlberg, Jul 14, 2014
  5. 04/19 refs.c: allow passing NULL to ref_transaction_freeRonnie Sahlberg, Jul 14, 2014
  6. 05/19 refs.c: add a strbuf argument to ref_transaction_commit for error loggingRonnie Sahlberg, Jul 14, 2014
  7. 06/19 lockfile.c: add a new public function unable_to_lock_messageRonnie Sahlberg, Jul 14, 2014
  8. 07/19 lockfile.c: make lock_file return a meaningful errno on failureRonnie Sahlberg, Jul 14, 2014
  9. 08/19 refs.c: add an err argument to repack_without_refsRonnie Sahlberg, Jul 14, 2014
  10. 09/19 refs.c: make sure log_ref_setup returns a meaningful errnoRonnie Sahlberg, Jul 14, 2014
  11. 10/19 refs.c: verify_lock should set errno to something meaningfulRonnie Sahlberg, Jul 14, 2014
  12. 11/19 refs.c: make remove_empty_directories always set errno to something saneRonnie Sahlberg, Jul 14, 2014
  13. 12/19 refs.c: commit_packed_refs to return a meaningful errno on failureRonnie Sahlberg, Jul 14, 2014
  14. 13/19 refs.c: make resolve_ref_unsafe set errno to something meaningful on errorRonnie Sahlberg, Jul 14, 2014
  15. 14/19 refs.c: log_ref_write should try to return meaningful errnoRonnie Sahlberg, Jul 14, 2014
  16. 15/19 refs.c: make ref_update_reject_duplicates take a strbuf argument for errorsRonnie Sahlberg, Jul 14, 2014
  17. 16/19 refs.c: make update_ref_write update a strbuf on failureRonnie Sahlberg, Jul 14, 2014
  18. 17/19 update-ref: use err argument to get error from ref_transaction_commitRonnie Sahlberg, Jul 14, 2014
  19. 18/19 refs.c: remove the onerr argument to ref_transaction_commitRonnie Sahlberg, Jul 14, 2014
  20. 19/19 refs.c: change ref_transaction_update() to do error checking and return statusRonnie Sahlberg, Jul 14, 2014

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.