git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael Haggerty <mhagger@alum.mit.edu>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [PATCH 5/7] refs: tidy up and adjust visibility of the `ref_update` flags
Date: Sun, 5 Nov 2017 08:19:37 +0100	[thread overview]
Message-ID: <6a0407b8-a612-5adb-6152-2e43bb2b05f0@alum.mit.edu> (raw)
In-Reply-To: <20171101081808.5962-1-martin.agren@gmail.com>

On 11/01/2017 09:18 AM, Martin Ågren wrote:
> On 28 October 2017 at 11:49, Michael Haggerty <mhagger@alum.mit.edu> wrote:
>> The constants used for `ref_update::flags` were rather disorganized:
> 
>> * The documentation wasn't very consistent and partly still referred
>>   to sha1s rather than oids.
> 
>> @@ -478,22 +462,23 @@ struct ref_transaction *ref_transaction_begin(struct strbuf *err);
>>   *
>>   *     refname -- the name of the reference to be affected.
>>   *
>> - *     new_sha1 -- the SHA-1 that should be set to be the new value of
>> + *     new_oid -- the SHA-1 that should be set to be the new value of
>>   *         the reference. Some functions allow this parameter to be
>>   *         NULL, meaning that the reference is not changed, or
>> - *         null_sha1, meaning that the reference should be deleted. A
>> + *         null_oid, meaning that the reference should be deleted. A
>>   *         copy of this value is made in the transaction.
>>   *
>> - *     old_sha1 -- the SHA-1 value that the reference must have before
>> + *     old_oid -- the SHA-1 value that the reference must have before
> 
> You still refer to "SHA-1" twice in this hunk. Maybe squash this in, at
> least partially? This addresses all remaining "sha"/"SHA" in refs.h.
> [...]

Thanks for this.

I'll squash the changes that have to do with these flags into this
commit, and change the other docstrings as part of a separate commit
that also fixes up similar problems in other refs-related comments.

I also realized that `write_packed_entry()` still takes `unsigned char
*` arguments. I'll fix that, too, in yet another commit.

Thanks,
Michael


  reply	other threads:[~2017-11-05  7:19 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-28  9:49 [PATCH 0/7] Tidy up the constants related to ref_update::flags Michael Haggerty
2017-10-28  9:49 ` [PATCH 1/7] files_transaction_prepare(): don't leak flags to packed transaction Michael Haggerty
2017-10-30  4:44   ` Junio C Hamano
2017-11-05  6:46     ` Michael Haggerty
2017-11-06  1:28       ` Junio C Hamano
2017-10-28  9:49 ` [PATCH 2/7] prune_ref(): call `ref_transaction_add_update()` directly Michael Haggerty
2017-10-28  9:49 ` [PATCH 3/7] ref_transaction_update(): die on disallowed flags Michael Haggerty
2017-10-28  9:49 ` [PATCH 4/7] ref_transaction_add_update(): remove a check Michael Haggerty
2017-10-28  9:49 ` [PATCH 5/7] refs: tidy up and adjust visibility of the `ref_update` flags Michael Haggerty
2017-11-01  8:18   ` Martin Ågren
2017-11-05  7:19     ` Michael Haggerty [this message]
2017-10-28  9:49 ` [PATCH 6/7] refs: rename constant `REF_NODEREF` to `REF_NO_DEREF` Michael Haggerty
2017-10-30  4:56   ` Junio C Hamano
2017-10-28  9:49 ` [PATCH 7/7] refs: rename constant `REF_ISPRUNING` to `REF_IS_PRUNING` Michael Haggerty

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6a0407b8-a612-5adb-6152-2e43bb2b05f0@alum.mit.edu \
    --to=mhagger@alum.mit.edu \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).