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

[GSoC][RFC PATCH v3 0/3] Add refs list subcommand

From
Meet Soni <meetsoni3017@gmail.com>
Date
Jul 23, 2025, 06:43 UTC
Message-ID
<20250723064313.29866-1-meetsoni3017@gmail.com>
In-Reply-To
<20250717075009.26262-1-meetsoni3017@gmail.com>
Hello everyone,

This is the third version of the patch series that introduces the `git refs list` subcommand as a modern alternative to `git for-each-ref`.

Thank you to everyone who provided valuable feedback on the patch series.

Changes in v3:
  - Restructured the patch series from two commits into three, providing
    a cleaner separation between the feature implementation, the test
    refactoring, and the new test itself.
  - Reworked the testing approach to follow the established pattern for
    shared tests (like git-blame/annotate). The core test logic now
    resides in a shared file (`for-each-ref-tests.sh`), which is sourced
    by both the original `t6300-for-each-ref.sh` and the new
    `t1461-refs-list.sh` test drivers.
  - Adopted the suggested `$git_for_each_ref` variable convention in the
    test suite for better clarity and to demonstrate the drop-in
    compatibility.
  - Removed unwanted comment.
---
(v1 cover-letter text)

This patch series introduces `git refs list` as a modern replacement for `git for-each-ref`, as part of an effort to consolidate ref-related functionality under a unified `git refs` command.

Git's ref-related operations are currently handled by several distinct commands, such as `git show-ref`, `git for-each-ref`, `git update-ref`, `git pack-refs`, etc. This distribution has a few practical drawbacks:

- Users need to rely on multiple commands for related tasks involving
  refs.
- The commands may differ slightly in behavior and option syntax,
  leading to inconsistency.

We propose a long-term consolidation effort to bring ref-related subcommands under the umbrella of a single command: `git refs`.

The implementation of `git refs list` is functionally identical to `git for-each-ref`. It reuses the same internal logic (cmd_for_each_ref) to ensure complete backward compatibility. The purpose of this patch is not to introduce new behavior but to provide an alternate entry point under the consolidated `git refs` namespace.

The motivation behind this change is twofold:
- Consolidation: Centralizing ref-related operations makes them easier
  to discover, use, and maintain.
- Evolution: While the initial goal is parity with existing commands,
  this consolidation allows for careful reconsideration of which
  features are essential. Over time, we can:
  - Remove legacy or obscure options that are no longer needed.
  - Add improvements that wouldn't make sense to bolt onto legacy
    commands.
  - Offering a more consistent and user-friendly surface.

To verify backward compatibility, this patch also includes a test `t/t1461-refs-list.sh`, which runs the full `t6300-for-each-ref.sh` test using `git refs list`. The test uses ${GIT_REFS_LIST_CMD:-for-each-ref} to allow substitution without duplicating tests.

This patch is deliberately conservative: it introduces no behavioral changes and leaves `for-each-ref` untouched. The goal is to lay groundwork and demonstrate viability of ref consolidation within `git refs`.

Going forward, I'd like to initiate a discussion on what the ideal surface of `git refs list` should look like. Which options and features from `for-each-ref` should be carried over? Are there any that are obsolete or overly niche? What improvements might be worth considering now that we have a new, consolidated interface?

Feedback on this, especially from those who rely on `for-each-ref` in scripts or tooling would be very helpful.

Meet Soni (3):
  builtin/refs: add list subcommand
  t6300: refactor tests to be shareable
  t: add test for git refs list subcommand
 Documentation/git-for-each-ref.adoc  |   80 +-
 Documentation/git-refs.adoc          |   16 +
 Documentation/refs-list-options.adoc |   79 +
 builtin/for-each-ref.c               |   24 +-
 builtin/refs.c                       |   35 +
 t/for-each-ref-tests.sh              | 2141 ++++++++++++++++++++++++++
 t/meson.build                        |    1 +
 t/t1461-refs-list.sh                 |    8 +
 t/t6300-for-each-ref.sh              | 2140 +------------------------
 9 files changed, 2303 insertions(+), 2221 deletions(-)
 create mode 100644 Documentation/refs-list-options.adoc
 create mode 100644 t/for-each-ref-tests.sh
 create mode 100755 t/t1461-refs-list.sh
Range-diff against v2:
1:  b2d3026520 ! 1:  547b0bbf8f builtin/refs: add list subcommand
    @@ Documentation/git-refs.adoc: The following options are specific to 'git refs ver
     
      ## Documentation/refs-list-options.adoc (new) ##
     @@
    -+// Shared options for for-each-ref and refs list
     +<pattern>...::
     +	If one or more patterns are given, only refs are shown that
     +	match against at least one pattern, either using fnmatch(3) or
2:  2d6534841f < -:  ---------- t: add test for git refs list subcommand
-:  ---------- > 2:  5d5057ff98 t6300: refactor tests to be shareable
-:  ---------- > 3:  b9cb9cdf48 t: add test for git refs list subcommand
-- 
2.34.1
Previous: Junio C HamanoNext: Meet Soni
Message 25 of 65 in “Add refs list subcommand”
  1. Meet SoniJun 27, 2025
  2. [GSoC][RFC PATCH 1/2] builtin/refs: add list subcommandMeet Soni, Jun 27, 2025
  3. Jean-Noël AvilaJun 27, 2025
  4. Junio C HamanoJun 27, 2025
  5. Meet SoniJun 30, 2025
  6. doc:git-for-each-ref: fix styling and typosJean-Noël Avila, Jun 29, 2025
  7. Junio C HamanoJun 30, 2025
  8. Jean-Noël AVILAJun 30, 2025
  9. [GSoC][RFC PATCH 2/2] t: add test for git refs list subcommandMeet Soni, Jun 27, 2025
  10. Junio C HamanoJun 27, 2025
  11. shejialuoJun 28, 2025
  12. Junio C HamanoJun 30, 2025
  13. shejialuoJul 6, 2025
  14. Meet SoniJun 30, 2025
  15. Junio C HamanoJun 30, 2025
  16. Patrick SteinhardtJul 9, 2025
  17. [GSoC][RFC PATCH v2 0/2] Add refs list subcommandMeet Soni, Jul 17, 2025
  18. [GSoC][RFC PATCH v2 1/2] builtin/refs: add list subcommandMeet Soni, Jul 17, 2025
  19. Eric SunshineJul 17, 2025
  20. Meet SoniJul 23, 2025
  21. [GSoC][RFC PATCH v2 2/2] t: add test for git refs list subcommandMeet Soni, Jul 17, 2025
  22. Junio C HamanoJul 17, 2025
  23. Meet SoniJul 23, 2025
  24. Junio C HamanoJul 23, 2025
  25. [GSoC][RFC PATCH v3 0/3] Add refs list subcommandMeet Soni, Jul 23, 2025
  26. [GSoC][RFC PATCH v3 1/3] builtin/refs: add list subcommandMeet Soni, Jul 23, 2025
  27. Patrick SteinhardtJul 24, 2025
  28. Junio C HamanoJul 24, 2025
  29. Meet SoniJul 25, 2025
  30. [GSoC][RFC PATCH v3 2/3] t6300: refactor tests to be shareableMeet Soni, Jul 23, 2025
  31. [GSoC][RFC PATCH v3 3/3] t: add test for git refs list subcommandMeet Soni, Jul 23, 2025
  32. [GSoC][RFC PATCH v4 0/5] Add refs list subcommandMeet Soni, Jul 31, 2025
  33. [GSoC][RFC PATCH v4 1/5] doc: factor out common optionMeet Soni, Jul 31, 2025
  34. [GSoC][RFC PATCH v4 2/5] builtin/for-each-ref: factor out core logic into a helperMeet Soni, Jul 31, 2025
  35. Patrick SteinhardtAug 1, 2025
  36. Meet SoniAug 4, 2025
  37. [GSoC][RFC PATCH v4 3/5] builtin/refs: add list subcommandMeet Soni, Jul 31, 2025
  38. Phillip WoodAug 1, 2025
  39. Junio C HamanoAug 1, 2025
  40. Phillip WoodAug 1, 2025
  41. Junio C HamanoAug 1, 2025
  42. Phillip WoodAug 4, 2025
  43. Meet SoniAug 4, 2025
  44. Phillip WoodAug 4, 2025
  45. Junio C HamanoAug 4, 2025
  46. [GSoC][RFC PATCH v4 4/5] t6300: refactor tests to be shareableMeet Soni, Jul 31, 2025
  47. [GSoC][RFC PATCH v4 5/5] t: add test for git refs list subcommandMeet Soni, Jul 31, 2025
  48. Patrick SteinhardtAug 1, 2025
  49. [GSoC][RFC PATCH v5 0/6] Add refs list subcommandMeet Soni, Aug 4, 2025
  50. [GSoC][RFC PATCH v5 1/6] doc: factor out common optionMeet Soni, Aug 4, 2025
  51. Junio C HamanoAug 4, 2025
  52. [GSoC][RFC PATCH v5 2/6] builtin/for-each-ref: align usage string with the man pageMeet Soni, Aug 4, 2025
  53. [GSoC][RFC PATCH v5 3/6] builtin/for-each-ref: factor out core logic into a helperMeet Soni, Aug 4, 2025
  54. [GSoC][RFC PATCH v5 4/6] builtin/refs: add list subcommandMeet Soni, Aug 4, 2025
  55. [GSoC][RFC PATCH v5 5/6] t6300: refactor tests to be shareableMeet Soni, Aug 4, 2025
  56. [GSoC][RFC PATCH v5 6/6] t: add test for git refs list subcommandMeet Soni, Aug 4, 2025
  57. [GSoC][PATCH v6 0/6] Add refs list subcommandMeet Soni, Aug 5, 2025
  58. [GSoC][PATCH v6 1/6] doc: factor out common optionMeet Soni, Aug 5, 2025
  59. [GSoC][PATCH v6 2/6] builtin/for-each-ref: align usage string with the man pageMeet Soni, Aug 5, 2025
  60. [GSoC][PATCH v6 3/6] builtin/for-each-ref: factor out core logic into a helperMeet Soni, Aug 5, 2025
  61. [GSoC][PATCH v6 4/6] builtin/refs: add list subcommandMeet Soni, Aug 5, 2025
  62. [GSoC][PATCH v6 5/6] t6300: refactor tests to be shareableMeet Soni, Aug 5, 2025
  63. [GSoC][PATCH v6 6/6] t: add test for git refs list subcommandMeet Soni, Aug 5, 2025
  64. Patrick SteinhardtAug 5, 2025
  65. Junio C HamanoAug 5, 2025

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.