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

Re: [PATCH v2 12/12] refs: move the remaining ref module declarations to refs.h

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 20, 2015, 03:30 UTC
Message-ID
<xmqq381n5a5g.fsf@gitster.dls.corp.google.com>
In-Reply-To
<5584C789.7020209@alum.mit.edu>
Michael Haggerty <mhagger@alum.mit.edu> writes:
Show 8 quoted lines
> Finally, when I'm inventing new functions (which I admit isn't the case
> here), I usually write the declaration first and then copy-paste it to
> the C file as the first step in writing the definition. If I name the
> parameters in the declaration then (a) I don't have to go back and edit
> them at the definition and (b) if parameter names are needed later at
> the declaration (e.g., for a docstring), I don't have to edit the
> declaration again, cross-referencing back to the C file to make sure I
> name them consistently.

That cuts both ways, though. After somebody decides to rename parameters that used to be "ref" after adding tons of other functions and names parameters to these new functions "refname", you have two places to update "ref" to "refname" for existing ones, not one.

> I will split the "add names in declarations" changes into a separate
> patch.

Yeah, please do so. I do not mind "add docstring and add names in declarations so that docstring can refer to them" patch at all, but that is a step separate from the "move the remaining declarations".

Previous: Michael HaggertyNext: Stefan Beller
Message 29 of 30 in “Improve "refs" module encapsulation”
  1. 00/12 Improve "refs" module encapsulationMichael Haggerty, Jun 13, 2015
  2. 01/12 delete_ref(): move declaration to refs.hMichael Haggerty, Jun 13, 2015
  3. 02/12 remove_branches(): remove temporaryMichael Haggerty, Jun 13, 2015
  4. 03/12 delete_ref(): handle special case more explicitlyMichael Haggerty, Jun 13, 2015
  5. Junio C HamanoJun 15, 2015
  6. 04/12 delete_refs(): new function for the refs APIMichael Haggerty, Jun 13, 2015
  7. 05/12 delete_refs(): improve error messageMichael Haggerty, Jun 13, 2015
  8. Junio C HamanoJun 15, 2015
  9. Michael HaggertyJun 19, 2015
  10. 06/12 prune_remote(): use delete_refs()Michael Haggerty, Jun 13, 2015
  11. Junio C HamanoJun 15, 2015
  12. Jeff KingJun 15, 2015
  13. Junio C HamanoJun 15, 2015
  14. 07/12 repack_without_refs(): make function privateMichael Haggerty, Jun 13, 2015
  15. 08/12 initial_ref_transaction_commit(): function for initial ref creationMichael Haggerty, Jun 13, 2015
  16. Junio C HamanoJun 15, 2015
  17. Junio C HamanoJun 15, 2015
  18. Jeff KingJun 15, 2015
  19. Junio C HamanoJun 15, 2015
  20. Michael HaggertyJun 20, 2015
  21. 09/12 refs: remove some functions from the module's public interfaceMichael Haggerty, Jun 13, 2015
  22. 10/12 initial_ref_transaction_commit(): check for duplicate refsMichael Haggerty, Jun 13, 2015
  23. 11/12 initial_ref_transaction_commit(): check for ref D/F conflictsMichael Haggerty, Jun 13, 2015
  24. 12/12 refs: move the remaining ref module declarations to refs.hMichael Haggerty, Jun 13, 2015
  25. Junio C HamanoJun 15, 2015
  26. Jeff KingJun 15, 2015
  27. Junio C HamanoJun 15, 2015
  28. Michael HaggertyJun 20, 2015
  29. Junio C HamanoJun 20, 2015
  30. Stefan BellerJun 15, 2015

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.