refs: update some more docs to use "oid" rather than "sha1"

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael Haggerty 2017-11-05 09:42:09 +01:00 committed by Junio C Hamano
parent 4170188262
commit 78fb457968
6 changed files with 26 additions and 27 deletions

2
refs.c
View File

@ -770,7 +770,7 @@ static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
if (cb->cutoff_cnt) if (cb->cutoff_cnt)
*cb->cutoff_cnt = cb->reccnt - 1; *cb->cutoff_cnt = cb->reccnt - 1;
/* /*
* we have not yet updated cb->[n|o]sha1 so they still * we have not yet updated cb->[n|o]oid so they still
* hold the values for the previous record. * hold the values for the previous record.
*/ */
if (!is_null_oid(&cb->ooid)) { if (!is_null_oid(&cb->ooid)) {

8
refs.h
View File

@ -126,7 +126,7 @@ int peel_ref(const char *refname, struct object_id *oid);
/** /**
* Resolve refname in the nested "gitlink" repository in the specified * Resolve refname in the nested "gitlink" repository in the specified
* submodule (which must be non-NULL). If the resolution is * submodule (which must be non-NULL). If the resolution is
* successful, return 0 and set sha1 to the name of the object; * successful, return 0 and set oid to the name of the object;
* otherwise, return a non-zero value. * otherwise, return a non-zero value.
*/ */
int resolve_gitlink_ref(const char *submodule, const char *refname, int resolve_gitlink_ref(const char *submodule, const char *refname,
@ -260,7 +260,7 @@ struct ref_transaction;
/* /*
* The signature for the callback function for the for_each_*() * The signature for the callback function for the for_each_*()
* functions below. The memory pointed to by the refname and sha1 * functions below. The memory pointed to by the refname and oid
* arguments is only guaranteed to be valid for the duration of a * arguments is only guaranteed to be valid for the duration of a
* single callback invocation. * single callback invocation.
*/ */
@ -354,7 +354,7 @@ int reflog_exists(const char *refname);
/* /*
* Delete the specified reference. If old_oid is non-NULL, then * Delete the specified reference. If old_oid is non-NULL, then
* verify that the current value of the reference is old_sha1 before * verify that the current value of the reference is old_oid before
* deleting it. If old_oid is NULL, delete the reference if it * deleting it. If old_oid is NULL, delete the reference if it
* exists, regardless of its old value. It is an error for old_oid to * exists, regardless of its old value. It is an error for old_oid to
* be null_oid. msg and flags are passed through to * be null_oid. msg and flags are passed through to
@ -633,7 +633,7 @@ int ref_transaction_abort(struct ref_transaction *transaction,
* It is a bug to call this function when there might be other * It is a bug to call this function when there might be other
* processes accessing the repository or if there are existing * processes accessing the repository or if there are existing
* references that might conflict with the ones being created. All * references that might conflict with the ones being created. All
* old_sha1 values must either be absent or NULL_SHA1. * old_oid values must either be absent or null_oid.
*/ */
int initial_ref_transaction_commit(struct ref_transaction *transaction, int initial_ref_transaction_commit(struct ref_transaction *transaction,
struct strbuf *err); struct strbuf *err);

View File

@ -240,7 +240,7 @@ static void loose_fill_ref_dir(struct ref_store *ref_store,
} else if (is_null_oid(&oid)) { } else if (is_null_oid(&oid)) {
/* /*
* It is so astronomically unlikely * It is so astronomically unlikely
* that NULL_SHA1 is the SHA-1 of an * that null_oid is the OID of an
* actual object that we consider its * actual object that we consider its
* appearance in a loose reference * appearance in a loose reference
* file to be repo corruption * file to be repo corruption
@ -473,7 +473,7 @@ static void unlock_ref(struct ref_lock *lock)
* are passed to refs_verify_refname_available() for this check. * are passed to refs_verify_refname_available() for this check.
* *
* If mustexist is not set and the reference is not found or is * If mustexist is not set and the reference is not found or is
* broken, lock the reference anyway but clear sha1. * broken, lock the reference anyway but clear old_oid.
* *
* Return 0 on success. On failure, write an error message to err and * Return 0 on success. On failure, write an error message to err and
* return TRANSACTION_NAME_CONFLICT or TRANSACTION_GENERIC_ERROR. * return TRANSACTION_NAME_CONFLICT or TRANSACTION_GENERIC_ERROR.
@ -1648,9 +1648,8 @@ static int files_log_ref_write(struct files_ref_store *refs,
} }
/* /*
* Write sha1 into the open lockfile, then close the lockfile. On * Write oid into the open lockfile, then close the lockfile. On
* errors, rollback the lockfile, fill in *err and * errors, rollback the lockfile, fill in *err and return -1.
* return -1.
*/ */
static int write_ref_to_lockfile(struct ref_lock *lock, static int write_ref_to_lockfile(struct ref_lock *lock,
const struct object_id *oid, struct strbuf *err) const struct object_id *oid, struct strbuf *err)
@ -2272,7 +2271,7 @@ static int split_symref_update(struct files_ref_store *refs,
/* /*
* Change the symbolic ref update to log only. Also, it * Change the symbolic ref update to log only. Also, it
* doesn't need to check its old SHA-1 value, as that will be * doesn't need to check its old OID value, as that will be
* done when new_update is processed. * done when new_update is processed.
*/ */
update->flags |= REF_LOG_ONLY | REF_NO_DEREF; update->flags |= REF_LOG_ONLY | REF_NO_DEREF;
@ -2341,7 +2340,7 @@ static int check_old_oid(struct ref_update *update, struct object_id *oid,
* Prepare for carrying out update: * Prepare for carrying out update:
* - Lock the reference referred to by update. * - Lock the reference referred to by update.
* - Read the reference under lock. * - Read the reference under lock.
* - Check that its old SHA-1 value (if specified) is correct, and in * - Check that its old OID value (if specified) is correct, and in
* any case record it in update->lock->old_oid for later use when * any case record it in update->lock->old_oid for later use when
* writing the reflog. * writing the reflog.
* - If it is a symref update without REF_NO_DEREF, split it up into a * - If it is a symref update without REF_NO_DEREF, split it up into a
@ -2396,7 +2395,7 @@ static int lock_ref_for_update(struct files_ref_store *refs,
/* /*
* We won't be reading the referent as part of * We won't be reading the referent as part of
* the transaction, so we have to read it here * the transaction, so we have to read it here
* to record and possibly check old_sha1: * to record and possibly check old_oid:
*/ */
if (refs_read_ref_full(&refs->base, if (refs_read_ref_full(&refs->base,
referent.buf, 0, referent.buf, 0,
@ -2416,7 +2415,7 @@ static int lock_ref_for_update(struct files_ref_store *refs,
/* /*
* Create a new update for the reference this * Create a new update for the reference this
* symref is pointing at. Also, we will record * symref is pointing at. Also, we will record
* and verify old_sha1 for this update as part * and verify old_oid for this update as part
* of processing the split-off update, so we * of processing the split-off update, so we
* don't have to do it here. * don't have to do it here.
*/ */
@ -2436,7 +2435,7 @@ static int lock_ref_for_update(struct files_ref_store *refs,
/* /*
* If this update is happening indirectly because of a * If this update is happening indirectly because of a
* symref update, record the old SHA-1 in the parent * symref update, record the old OID in the parent
* update: * update:
*/ */
for (parent_update = update->parent_update; for (parent_update = update->parent_update;

View File

@ -744,7 +744,7 @@ static int packed_read_raw_ref(struct ref_store *ref_store,
/* /*
* This value is set in `base.flags` if the peeled value of the * This value is set in `base.flags` if the peeled value of the
* current reference is known. In that case, `peeled` contains the * current reference is known. In that case, `peeled` contains the
* correct peeled value for the reference, which might be `null_sha1` * correct peeled value for the reference, which might be `null_oid`
* if the reference is not a tag or if it is broken. * if the reference is not a tag or if it is broken.
*/ */
#define REF_KNOWS_PEELED 0x40 #define REF_KNOWS_PEELED 0x40

View File

@ -260,8 +260,8 @@ int add_ref_entry(struct ref_dir *dir, struct ref_entry *ref)
/* /*
* Emit a warning and return true iff ref1 and ref2 have the same name * Emit a warning and return true iff ref1 and ref2 have the same name
* and the same sha1. Die if they have the same name but different * and the same oid. Die if they have the same name but different
* sha1s. * oids.
*/ */
static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2) static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
{ {

View File

@ -15,13 +15,13 @@
*/ */
/* /*
* The reference should be updated to new_sha1. * The reference should be updated to new_oid.
*/ */
#define REF_HAVE_NEW (1 << 2) #define REF_HAVE_NEW (1 << 2)
/* /*
* The current reference's value should be checked to make sure that * The current reference's value should be checked to make sure that
* it agrees with old_sha1. * it agrees with old_oid.
*/ */
#define REF_HAVE_OLD (1 << 3) #define REF_HAVE_OLD (1 << 3)
@ -86,7 +86,7 @@ enum peel_status {
* tag recursively until a non-tag is found. If successful, store the * tag recursively until a non-tag is found. If successful, store the
* result to oid and return PEEL_PEELED. If the object is not a tag * result to oid and return PEEL_PEELED. If the object is not a tag
* or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively, * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
* and leave sha1 unchanged. * and leave oid unchanged.
*/ */
enum peel_status peel_object(const struct object_id *name, struct object_id *oid); enum peel_status peel_object(const struct object_id *name, struct object_id *oid);
@ -98,11 +98,11 @@ enum peel_status peel_object(const struct object_id *name, struct object_id *oid
int copy_reflog_msg(char *buf, const char *msg); int copy_reflog_msg(char *buf, const char *msg);
/** /**
* Information needed for a single ref update. Set new_sha1 to the new * Information needed for a single ref update. Set new_oid to the new
* value or to null_sha1 to delete the ref. To check the old value * value or to null_oid to delete the ref. To check the old value
* while the ref is locked, set (flags & REF_HAVE_OLD) and set * while the ref is locked, set (flags & REF_HAVE_OLD) and set old_oid
* old_sha1 to the old value, or to null_sha1 to ensure the ref does * to the old value, or to null_oid to ensure the ref does not exist
* not exist before update. * before update.
*/ */
struct ref_update { struct ref_update {
/* /*
@ -158,7 +158,7 @@ int ref_update_reject_duplicates(struct string_list *refnames,
/* /*
* Add a ref_update with the specified properties to transaction, and * Add a ref_update with the specified properties to transaction, and
* return a pointer to the new object. This function does not verify * return a pointer to the new object. This function does not verify
* that refname is well-formed. new_sha1 and old_sha1 are only * that refname is well-formed. new_oid and old_oid are only
* dereferenced if the REF_HAVE_NEW and REF_HAVE_OLD bits, * dereferenced if the REF_HAVE_NEW and REF_HAVE_OLD bits,
* respectively, are set in flags. * respectively, are set in flags.
*/ */