test-hashmap: document why it is no longer used but still there

gitster · gitster · commit 9b0781196a0f · 2025-07-30T16:19:36.000-07:00
As I ended up wasting a few dozen minutes looking for the reason why
this is still here, help future developers by saving them from
wasting their time by documenting why this code that apparently is
not used by anybody is still here.

Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/t/helper/test-hashmap.c b/t/helper/test-hashmap.c
@@ -137,6 +137,11 @@ static void perf_hashmap(unsigned int method, unsigned int rounds)
  * Read stdin line by line and print result of commands to stdout:
  *
  * perfhashmap method rounds -> test hashmap.[ch] performance
+ *
+ * NOTE: this is not used by any of our mechanized build & test
+ * procedure, after 3469a236 (t: port helper/test-hashmap.c to
+ * unit-tests/t-hashmap.c, 2024-08-03).  See the log message of that
+ * commit for the reason why this is still here.
  */
 int cmd__hashmap(int argc UNUSED, const char **argv UNUSED)
 {

Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,11 @@ static void perf_hashmap(unsigned int method, unsigned int rounds)`
`137`	`137`	`* Read stdin line by line and print result of commands to stdout:`
`138`	`138`	`*`
`139`	`139`	`* perfhashmap method rounds -> test hashmap.[ch] performance`
	`140`	`+ *`
	`141`	`+ * NOTE: this is not used by any of our mechanized build & test`
	`142`	`+ * procedure, after 3469a236 (t: port helper/test-hashmap.c to`
	`143`	`+ * unit-tests/t-hashmap.c, 2024-08-03). See the log message of that`
	`144`	`+ * commit for the reason why this is still here.`
`140`	`145`	`*/`
`141`	`146`	`int cmd__hashmap(int argc UNUSED, const char **argv UNUSED)`
`142`	`147`	`{`