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

Re: [PATCH v7 04/17] ref-filter: modify "%(objectname:short)" to take length

From
Jacob Keller <jacob.keller@gmail.com>
Date
Nov 8, 2016, 23:27 UTC
Message-ID
<CA+P7+xqG5ACT2ZB=M8gLmDaYgSgX202+afJmZJKat6NzbFzL=g@mail.gmail.com>
In-Reply-To
<20161108201211.25213-5-Karthik.188@gmail.com>
On Tue, Nov 8, 2016 at 12:11 PM, Karthik Nayak <karthik.188@gmail.com> wrote:
Show 8 quoted lines
> From: Karthik Nayak <karthik.188@gmail.com>
>
> Add support for %(objectname:short=<length>) which would print the
> abbreviated unique objectname of given length. When no length is
> specified, the length is 'DEFAULT_ABBREV'. The minimum length is
> 'MINIMUM_ABBREV'. The length may be exceeded to ensure that the provided
> object name is unique.
>

Ok this makes sense. It may be annoying that the length might go beyond the size that we wanted, but I think it's better than printing a non-unique short abbreviation.

I have one suggested change, which is to drop O_LENGTH and have O_SHORT store the length always, setting it to DEFAULT_ABBREV when no length provided. This allows you to drop some code. I don't think it's actually worth a re-roll by itself since the current code is correct.

Thanks, Jake

Show 60 quoted lines
> Add tests and documentation for the same.
>
> Mentored-by: Christian Couder <christian.couder@gmail.com>
> Mentored-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> Helped-by: Jacob Keller <jacob.keller@gmail.com>
> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
>  Documentation/git-for-each-ref.txt |  4 ++++
>  ref-filter.c                       | 25 +++++++++++++++++++------
>  t/t6300-for-each-ref.sh            | 10 ++++++++++
>  3 files changed, 33 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
> index b7b8560..92184c4 100644
> --- a/Documentation/git-for-each-ref.txt
> +++ b/Documentation/git-for-each-ref.txt
> @@ -107,6 +107,10 @@ objectsize::
>  objectname::
>         The object name (aka SHA-1).
>         For a non-ambiguous abbreviation of the object name append `:short`.
> +       For an abbreviation of the object name with desired length append
> +       `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The
> +       length may be exceeded to ensure unique object names.
> +
>
>  upstream::
>         The name of a local ref which can be considered ``upstream''
> diff --git a/ref-filter.c b/ref-filter.c
> index 44481c3..fe4ea2b 100644
> --- a/ref-filter.c
> +++ b/ref-filter.c
> @@ -55,7 +55,10 @@ static struct used_atom {
>                         const char *if_equals,
>                                 *not_equals;
>                 } if_then_else;
> -               enum { O_FULL, O_SHORT } objectname;
> +               struct {
> +                       enum { O_FULL, O_LENGTH, O_SHORT } option;
> +                       unsigned int length;
> +               } objectname;
>         } u;
>  } *used_atom;
>  static int used_atom_cnt, need_tagged, need_symref;
> @@ -118,10 +121,17 @@ static void contents_atom_parser(struct used_atom *atom, const char *arg)
>  static void objectname_atom_parser(struct used_atom *atom, const char *arg)
>  {
>         if (!arg)
> -               atom->u.objectname = O_FULL;
> +               atom->u.objectname.option = O_FULL;
>         else if (!strcmp(arg, "short"))
> -               atom->u.objectname = O_SHORT;
> -       else
> +               atom->u.objectname.option = O_SHORT;
> +       else if (skip_prefix(arg, "short=", &arg)) {
> +               atom->u.objectname.option = O_LENGTH;
> +               if (strtoul_ui(arg, 10, &atom->u.objectname.length) ||
> +                   atom->u.objectname.length == 0)
> +                       die(_("positive value expected objectname:short=%s"), arg);
> +               if (atom->u.objectname.length < MINIMUM_ABBREV)
> +                       atom->u.objectname.length = MINIMUM_ABBREV;

One way to reduce some code is to set O_SHORT and O_LENGTH as the same (either O_SHORT or O_LENGTH) and when no length is found simply set it to the DEFAULT_ABBREV.

Show 12 quoted lines
> +       } else
>                 die(_("unrecognized %%(objectname) argument: %s"), arg);
>  }
>
> @@ -591,12 +601,15 @@ static int grab_objectname(const char *name, const unsigned char *sha1,
>                            struct atom_value *v, struct used_atom *atom)
>  {
>         if (starts_with(name, "objectname")) {
> -               if (atom->u.objectname == O_SHORT) {
> +               if (atom->u.objectname.option == O_SHORT) {
>                         v->s = xstrdup(find_unique_abbrev(sha1, DEFAULT_ABBREV));
>                         return 1;
That would allow dropping an entire section here.

I don't think this is worth a re-roll by itself, and I think either approach is probably ok.

Show 48 quoted lines
> -               } else if (atom->u.objectname == O_FULL) {
> +               } else if (atom->u.objectname.option == O_FULL) {
>                         v->s = xstrdup(sha1_to_hex(sha1));
>                         return 1;
> +               } else if (atom->u.objectname.option == O_LENGTH) {
> +                       v->s = xstrdup(find_unique_abbrev(sha1, atom->u.objectname.length));
> +                       return 1;
>                 } else
>                         die("BUG: unknown %%(objectname) option");
>         }
> diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh
> index 19a2823..2be0a3f 100755
> --- a/t/t6300-for-each-ref.sh
> +++ b/t/t6300-for-each-ref.sh
> @@ -60,6 +60,8 @@ test_atom head objecttype commit
>  test_atom head objectsize 171
>  test_atom head objectname $(git rev-parse refs/heads/master)
>  test_atom head objectname:short $(git rev-parse --short refs/heads/master)
> +test_atom head objectname:short=1 $(git rev-parse --short=1 refs/heads/master)
> +test_atom head objectname:short=10 $(git rev-parse --short=10 refs/heads/master)
>  test_atom head tree $(git rev-parse refs/heads/master^{tree})
>  test_atom head parent ''
>  test_atom head numparent 0
> @@ -99,6 +101,8 @@ test_atom tag objecttype tag
>  test_atom tag objectsize 154
>  test_atom tag objectname $(git rev-parse refs/tags/testtag)
>  test_atom tag objectname:short $(git rev-parse --short refs/tags/testtag)
> +test_atom head objectname:short=1 $(git rev-parse --short=1 refs/heads/master)
> +test_atom head objectname:short=10 $(git rev-parse --short=10 refs/heads/master)
>  test_atom tag tree ''
>  test_atom tag parent ''
>  test_atom tag numparent ''
> @@ -164,6 +168,12 @@ test_expect_success 'Check invalid format specifiers are errors' '
>         test_must_fail git for-each-ref --format="%(authordate:INVALID)" refs/heads
>  '
>
> +test_expect_success 'arguments to %(objectname:short=) must be positive integers' '
> +       test_must_fail git for-each-ref --format="%(objectname:short=0)" &&
> +       test_must_fail git for-each-ref --format="%(objectname:short=-1)" &&
> +       test_must_fail git for-each-ref --format="%(objectname:short=foo)"
> +'
> +
>  test_date () {
>         f=$1 &&
>         committer_date=$2 &&
> --
> 2.10.2
>
Previous: Karthik NayakNext: Karthik Nayak
Message 22 of 94 in “port branch.c to use ref-filter's printing options”
  1. 00/17 port branch.c to use ref-filter's printing optionsKarthik Nayak, Nov 8, 2016
  2. 01/17 ref-filter: implement %(if), %(then), and %(else) atomsKarthik Nayak, Nov 8, 2016
  3. Jacob KellerNov 8, 2016
  4. Karthik NayakNov 10, 2016
  5. Junio C HamanoNov 10, 2016
  6. Karthik NayakNov 11, 2016
  7. Junio C HamanoNov 10, 2016
  8. Karthik NayakNov 11, 2016
  9. 02/17 ref-filter: include reference to 'used_atom' within 'atom_value'Karthik Nayak, Nov 8, 2016
  10. Jacob KellerNov 8, 2016
  11. Karthik NayakNov 10, 2016
  12. 03/17 ref-filter: implement %(if:equals=<string>) and %(if:notequals=<string>)Karthik Nayak, Nov 8, 2016
  13. Jacob KellerNov 8, 2016
  14. Karthik NayakNov 10, 2016
  15. Jacob KellerNov 11, 2016
  16. Junio C HamanoNov 10, 2016
  17. Jacob KellerNov 11, 2016
  18. Karthik NayakNov 12, 2016
  19. Jakub NarębskiNov 18, 2016
  20. Karthik NayakNov 20, 2016
  21. 04/17 ref-filter: modify "%(objectname:short)" to take lengthKarthik Nayak, Nov 8, 2016
  22. Jacob KellerNov 8, 2016
  23. Karthik NayakNov 10, 2016
  24. Jacob KellerNov 11, 2016
  25. Karthik NayakNov 12, 2016
  26. Junio C HamanoNov 10, 2016
  27. 05/17 ref-filter: move get_head_description() from branch.cKarthik Nayak, Nov 8, 2016
  28. Jacob KellerNov 8, 2016
  29. Karthik NayakNov 10, 2016
  30. 06/17 ref-filter: introduce format_ref_array_item()Karthik Nayak, Nov 8, 2016
  31. Jacob KellerNov 8, 2016
  32. 08/17 ref-filter: add support for %(upstream:track,nobracket)Karthik Nayak, Nov 8, 2016
  33. Jacob KellerNov 8, 2016
  34. Karthik NayakNov 12, 2016
  35. 07/17 ref-filter: make %(upstream:track) prints "[gone]" for invalid upstreamsKarthik Nayak, Nov 8, 2016
  36. Jacob KellerNov 8, 2016
  37. Karthik NayakNov 12, 2016
  38. 09/17 ref-filter: make "%(symref)" atom work with the ':short' modifierKarthik Nayak, Nov 8, 2016
  39. Jacob KellerNov 8, 2016
  40. Jakub NarębskiNov 18, 2016
  41. Karthik NayakNov 20, 2016
  42. 10/17 ref-filter: introduce refname_atom_parser_internal()Karthik Nayak, Nov 8, 2016
  43. Jakub NarębskiNov 18, 2016
  44. Karthik NayakNov 20, 2016
  45. 11/17 ref-filter: introduce symref_atom_parser() and refname_atom_parser()Karthik Nayak, Nov 8, 2016
  46. Jacob KellerNov 8, 2016
  47. Karthik NayakNov 12, 2016
  48. 12/17 ref-filter: make remote_ref_atom_parser() use refname_atom_parser_internal()Karthik Nayak, Nov 8, 2016
  49. Jacob KellerNov 8, 2016
  50. 14/17 ref-filter: allow porcelain to translate messages in the outputKarthik Nayak, Nov 8, 2016
  51. Jacob KellerNov 9, 2016
  52. Jakub NarębskiNov 18, 2016
  53. Karthik NayakNov 20, 2016
  54. Matthieu MoyNov 21, 2016
  55. Karthik NayakNov 22, 2016
  56. 13/17 ref-filter: add `:dir` and `:base` options for ref printing atomsKarthik Nayak, Nov 8, 2016
  57. Jacob KellerNov 8, 2016
  58. Karthik NayakNov 13, 2016
  59. Junio C HamanoNov 14, 2016
  60. Karthik NayakNov 14, 2016
  61. Junio C HamanoNov 14, 2016
  62. Karthik NayakNov 15, 2016
  63. Jacob KellerNov 15, 2016
  64. Jacob KellerNov 15, 2016
  65. Junio C HamanoNov 15, 2016
  66. Jacob KellerNov 15, 2016
  67. Karthik NayakNov 16, 2016
  68. Junio C HamanoNov 17, 2016
  69. Karthik NayakNov 18, 2016
  70. Jacob KellerNov 18, 2016
  71. Junio C HamanoNov 18, 2016
  72. Jakub NarębskiNov 18, 2016
  73. Karthik NayakNov 20, 2016
  74. Karthik NayakNov 20, 2016
  75. Junio C HamanoNov 20, 2016
  76. Jakub NarębskiNov 20, 2016
  77. Karthik NayakNov 22, 2016
  78. 16/17 branch: use ref-filter printing APIsKarthik Nayak, Nov 8, 2016
  79. Jacob KellerNov 9, 2016
  80. Karthik NayakNov 14, 2016
  81. Jacob KellerNov 15, 2016
  82. Junio C HamanoNov 17, 2016
  83. Junio C HamanoNov 17, 2016
  84. Karthik NayakNov 22, 2016
  85. 15/17 branch, tag: use porcelain outputKarthik Nayak, Nov 8, 2016
  86. Jacob KellerNov 9, 2016
  87. 17/17 branch: implement '--format' optionKarthik Nayak, Nov 8, 2016
  88. Jacob KellerNov 9, 2016
  89. Karthik NayakNov 14, 2016
  90. Junio C HamanoNov 15, 2016
  91. Re* [PATCH v7 00/17] port branch.c to use ref-filter's printing optionsJunio C Hamano, Nov 15, 2016
  92. Karthik NayakNov 16, 2016
  93. Junio C HamanoNov 18, 2016
  94. Karthik NayakNov 20, 2016

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.