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

Re: [PATCH 5/7] refs: tidy up and adjust visibility of the `ref_update` flags

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
Nov 5, 2017, 07:19 UTC
Message-ID
<6a0407b8-a612-5adb-6152-2e43bb2b05f0@alum.mit.edu>
In-Reply-To
<20171101081808.5962-1-martin.agren@gmail.com>
On 11/01/2017 09:18 AM, Martin Ågren wrote:
Show 24 quoted lines
> 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

Previous: Martin ÅgrenNext: Michael Haggerty
Message 13 of 14 in “Tidy up the constants related to ref_update::flags”
  1. 0/7 Tidy up the constants related to ref_update::flagsMichael Haggerty, Oct 28, 2017
  2. 2/7 prune_ref(): call `ref_transaction_add_update()` directlyMichael Haggerty, Oct 28, 2017
  3. 3/7 ref_transaction_update(): die on disallowed flagsMichael Haggerty, Oct 28, 2017
  4. 1/7 files_transaction_prepare(): don't leak flags to packed transactionMichael Haggerty, Oct 28, 2017
  5. Junio C HamanoOct 30, 2017
  6. Michael HaggertyNov 5, 2017
  7. Junio C HamanoNov 6, 2017
  8. 4/7 ref_transaction_add_update(): remove a checkMichael Haggerty, Oct 28, 2017
  9. 6/7 refs: rename constant `REF_NODEREF` to `REF_NO_DEREF`Michael Haggerty, Oct 28, 2017
  10. Junio C HamanoOct 30, 2017
  11. 5/7 refs: tidy up and adjust visibility of the `ref_update` flagsMichael Haggerty, Oct 28, 2017
  12. Martin ÅgrenNov 1, 2017
  13. Michael HaggertyNov 5, 2017
  14. 7/7 refs: rename constant `REF_ISPRUNING` to `REF_IS_PRUNING`Michael Haggerty, Oct 28, 2017

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.