submodule: trace adding submodule ODB as alternate

Submodule ODBs are never added as alternates during the execution of the test suite, but there may be a rare interaction that the test suite does not have coverage of. Add a trace message when this happens, so that users who trace their commands can notice such occurrences. Signed-off-by: Jonathan Tan <jonathantanmy@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jonathan Tan committed Oct 8, 2021 at 14:08 UTC 71ef66d7403c05a6fe8ec118431332a8919b52a2
2 files changed +4 -5
submodule.c
+2
@@ -201,6 +201,8 @@ int register_all_submodule_odb_as_alternates(void)
201 add_to_alternates_memory(added_submodule_odb_paths.items[i].string);
202 if (ret) {
203 string_list_clear(&added_submodule_odb_paths, 0);
204 + trace2_data_intmax("submodule", the_repository,
205 + "register_all_submodule_odb_as_alternates/registered", ret);
206 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
207 BUG("register_all_submodule_odb_as_alternates() called");
208 }
t/README
+2 -5
@@ -456,11 +456,8 @@ GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB=<boolean>, when true, makes
456 registering submodule ODBs as alternates a fatal action. Support for
457 this environment variable can be removed once the migration to
458 explicitly providing repositories when accessing submodule objects is
459 -complete (in which case we might want to replace this with a trace2
460 -call so that users can make it visible if accessing submodule objects
461 -without an explicit repository still happens) or needs to be abandoned
462 -for whatever reason (in which case the migrated codepaths still retain
463 -their performance benefits).
459 +complete or needs to be abandoned for whatever reason (in which case the
460 +migrated codepaths still retain their performance benefits).
461
462 Naming Tests
463 ------------