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

[PATCH 03/15] ref-filter: modify "%(objectname:short)" to take length

From
Karthik Nayak <karthik.188@gmail.com>
Date
Mar 6, 2016, 12:04 UTC
Message-ID
<1457265902-7949-4-git-send-email-Karthik.188@gmail.com>
In-Reply-To
<1457265902-7949-1-git-send-email-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 7 is used. The minimum length is 'MINIMUM_ABBREV'.

Add tests and documentation for the same.
Mentored-by: Christian Couder <christian.couder@gmail.com>
Mentored-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
---
 ref-filter.c            | 25 +++++++++++++++++++------
 t/t6300-for-each-ref.sh | 10 ++++++++++
 2 files changed, 29 insertions(+), 6 deletions(-)
diff --git a/ref-filter.c b/ref-filter.c
index 440e270..2ab90d4 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -51,7 +51,10 @@ static struct used_atom {
 			enum { C_BARE, C_BODY, C_BODY_DEP, C_LINES, C_SIG, C_SUB } option;
 			unsigned int nlines;
 		} contents;
-		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;
@@ -114,10 +117,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.contents.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;
+	} else
 		die(_("unrecognized %%(objectname) argument: %s"), arg);
 }
 
@@ -581,12 +591,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;
-		} 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.7.2
Previous: Karthik NayakNext: Karthik Nayak
Message 8 of 30 in “port branch.c to use ref-filter's printing options”
  1. 00/15 port branch.c to use ref-filter's printing optionsKarthik Nayak, Mar 6, 2016
  2. 01/15 ref-filter: implement %(if), %(then), and %(else) atomsKarthik Nayak, Mar 6, 2016
  3. 02/15 ref-filter: implement %(if:equals=<string>) and %(if:notequals=<string>)Karthik Nayak, Mar 6, 2016
  4. Junio C HamanoMar 7, 2016
  5. Karthik NayakMar 8, 2016
  6. Junio C HamanoMar 8, 2016
  7. Karthik NayakMar 8, 2016
  8. 03/15 ref-filter: modify "%(objectname:short)" to take lengthKarthik Nayak, Mar 6, 2016
  9. 04/15 ref-filter: move get_head_description() from branch.cKarthik Nayak, Mar 6, 2016
  10. 05/15 ref-filter: introduce format_ref_array_item()Karthik Nayak, Mar 6, 2016
  11. 06/15 ref-filter: make %(upstream:track) prints "[gone]" for invalid upstreamsKarthik Nayak, Mar 6, 2016
  12. Jacob KellerMar 8, 2016
  13. Karthik NayakMar 8, 2016
  14. 07/15 ref-filter: add support for %(upstream:track,nobracket)Karthik Nayak, Mar 6, 2016
  15. 08/15 ref-filter: make "%(symref)" atom work with the ':short' modifierKarthik Nayak, Mar 6, 2016
  16. Junio C HamanoMar 7, 2016
  17. Jacob KellerMar 8, 2016
  18. Karthik NayakMar 8, 2016
  19. Junio C HamanoMar 8, 2016
  20. Karthik NayakMar 9, 2016
  21. 09/15 ref-filter: introduce symref_atom_parser()Karthik Nayak, Mar 6, 2016
  22. 10/15 ref-filter: introduce refname_atom_parser()Karthik Nayak, Mar 6, 2016
  23. 11/15 ref-filter: add support for %(refname:dir) and %(refname:base)Karthik Nayak, Mar 6, 2016
  24. 12/15 ref-filter: allow porcelain to translate messages in the outputKarthik Nayak, Mar 6, 2016
  25. 13/15 branch, tag: use porcelain outputKarthik Nayak, Mar 6, 2016
  26. 14/15 branch: use ref-filter printing APIsKarthik Nayak, Mar 6, 2016
  27. Junio C HamanoMar 7, 2016
  28. 15/15 branch: implement '--format' optionKarthik Nayak, Mar 6, 2016
  29. Jacob KellerMar 8, 2016
  30. Karthik NayakMar 15, 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.