# [PATCH v3 1/5] Makefile: wire up build option for deprecated features 10 messages from 2025-01-20 to 2025-01-22. Participants: Patrick Steinhardt, Junio C Hamano. Thread: https://gitlist.dev/t/62830 ## Patrick Steinhardt, 2025-01-20 07:42 Subject: [PATCH v3 0/5] remote: announce removal of "branches/" and "remotes/" Message-ID: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f%40pks.im In-Reply-To: <20241211-pks-remote-branches-deprecation-v1-0-1431e2369135@pks.im> ``` Hi, back when Git was in its infancy, remotes were configured via separate files in "branches/" (back in 2005). Later that year we introduced a more powerful mechanism with the "remotes/" directory. These mechanism have eventually been superseded by config-based remotes, and it is very unlikely that anybody still uses these directories to configure their remotes. Both of these directories have been marked as deprecated, one in 2005 and the other one in 2011. This patch series follows through with the deprecation of these and announces them for removal in Git 3.0. Furthermore, it creates the infra to compile Git with such breaking changes enabled and wires up a CI job both for GitHub and GitLab to test those breaking changes. The series is based on top caacdb5dfd (The fifteenth batch, 2024-12-10) with ps/build at 904339edbd (Introduce support for the Meson build system, 2024-12-06) merged into it. Changes in v2: - Some small fixes to the deprecation notice of "branches/" and "remotes/". - Some small fixes to commit messages. - Link to v1: https://lore.kernel.org/r/20241211-pks-remote-branches-deprecation-v1-0-1431e2369135@pks.im Changes in v3: - Print warnings when reading remotes from "remotes/" or "branches/". - A couple of commit mesasge improvements. - Link to v2: https://lore.kernel.org/r/20250106-pks-remote-branches-deprecation-v2-0-2ce87c053536@pks.im Thanks! Patrick --- Patrick Steinhardt (5): Makefile: wire up build option for deprecated features ci: merge linux-gcc-default into linux-gcc ci: repurpose "linux-gcc" job for deprecations builtin/pack-redundant: remove subcommand with breaking changes remote: announce removal of "branches/" and "remotes/" .github/workflows/main.yml | 6 +---- .gitlab-ci.yml | 6 +---- Documentation/BreakingChanges.txt | 25 ++++++++++++++++++ Documentation/gitrepository-layout.txt | 7 +++-- GIT-BUILD-OPTIONS.in | 1 + Makefile | 7 +++++ builtin/remote.c | 2 ++ ci/lib.sh | 5 ---- ci/run-build-and-tests.sh | 3 ++- contrib/buildsystems/CMakeLists.txt | 1 + git.c | 2 ++ meson.build | 6 +++++ meson_options.txt | 2 ++ remote.c | 19 ++++++++++++++ remote.h | 2 ++ t/t5323-pack-redundant.sh | 6 +++++ t/t5505-remote.sh | 6 ++--- t/t5510-fetch.sh | 13 ++++------ t/t5515-fetch-merge-logic.sh | 47 ++++++++++++++++++---------------- t/t5516-fetch-push.sh | 14 +++++----- t/test-lib.sh | 4 +++ 21 files changed, 125 insertions(+), 59 deletions(-) Range-diff versus v2: 1: bc6d8bcb19 ! 1: 3ceab66906 Makefile: wire up build option for deprecated features @@ Commit message such a switch because they predate those instructions. Introduce the proposed `WITH_BREAKING_CHANGES` preprocessor macro and - wire it up with both our Makefiles and Meson. + wire it up with both our Makefiles and Meson. This does not yet wire up + the build flag for existing deprecations. Signed-off-by: Patrick Steinhardt 2: 015a70e998 ! 2: 408f3afa48 ci: merge linux-gcc-default into linux-gcc @@ Commit message have other testcases that don't and also some that explicitly use "master". - So overall, the job does not add much to our test coverage. Merge it - into our "linux-gcc" job to reduce our test matrix a bit. + - We use "ubuntu:20.04" in one job and "ubuntu:latest" in another. We + already have a couple other jobs testing these respectively. + + So overall, the job does not add much to our test coverage. + + Drop the "linux-gcc-default" job and adapt "linux-gcc" to start using + the default GCC compiler, effectively merging those two jobs into one. Signed-off-by: Patrick Steinhardt 3: f776eb0e4e = 3: 545df94c7d ci: repurpose "linux-gcc" job for deprecations 4: c40f85dde2 = 4: 0142480800 builtin/pack-redundant: remove subcommand with breaking changes 5: 78bda8dd6b ! 5: a67bde4eda remote: announce removal of "branches/" and "remotes/" @@ Commit message Back when Git was in its infancy, remotes were configured via separate files in "branches/" (back in 2005). This mechanism was replaced later - that year with the "remotes/" directory. These mechanism have eventually + that year with the "remotes/" directory. Both mechanisms have eventually been replaced by config-based remotes, and it is very unlikely that anybody still uses these directories to configure their remotes. @@ remote.c: static void add_instead_of(struct rewrite *rewrite, const char *instea static const char *skip_spaces(const char *s) { while (isspace(*s)) +@@ remote.c: static void read_remotes_file(struct remote_state *remote_state, + + if (!f) + return; ++ ++ warning(_("Reading remote from \"remotes/%s\", which is nominated\n" ++ "for removal. If you still use the \"remotes/\" directory\n" ++ "it is recommended to migrate to config-based remotes. If\n" ++ "you cannot, please let us know you still use it by sending\n" ++ "an e-mail to ."), remote->name); ++ + remote->configured_in_repo = 1; + remote->origin = REMOTE_REMOTES; + while (strbuf_getline(&buf, f) != EOF) { +@@ remote.c: static void read_branches_file(struct remote_state *remote_state, + if (!f) + return; + ++ warning(_("Reading remote from \"branches/%s\", which is nominated\n" ++ "for removal. If you still use the \"branches/\" directory\n" ++ "it is recommended to migrate to config-based remotes. If\n" ++ "you cannot, please let us know you still use it by sending\n" ++ "an e-mail to ."), remote->name); ++ + strbuf_getline_lf(&buf, f); + fclose(f); + strbuf_trim(&buf); @@ remote.c: static void read_branches_file(struct remote_state *remote_state, strbuf_release(&buf); free(to_free); --- base-commit: 713ec79a9091cec60b110d605b418904759982ab change-id: 20241205-pks-remote-branches-deprecation-037a4389a377 ``` ## Patrick Steinhardt, 2025-01-20 07:42 Subject: [PATCH v3 1/5] Makefile: wire up build option for deprecated features Message-ID: <20250120-pks-remote-branches-deprecation-v3-1-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-1-c7e539b6a84f%40pks.im In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> ``` With 57ec9254eb (docs: introduce document to announce breaking changes, 2024-06-14), we have introduced a new document that tracks upcoming breaking changes in the Git project. In 2454970930 (BreakingChanges: early adopter option, 2024-10-11) we have amended the document a bit to mention that any introduced breaking changes must be accompanied by logic that allows us to enable the breaking change at compile-time. While we already have two breaking changes lined up, neither of them has such a switch because they predate those instructions. Introduce the proposed `WITH_BREAKING_CHANGES` preprocessor macro and wire it up with both our Makefiles and Meson. This does not yet wire up the build flag for existing deprecations. Signed-off-by: Patrick Steinhardt --- GIT-BUILD-OPTIONS.in | 1 + Makefile | 5 +++++ contrib/buildsystems/CMakeLists.txt | 1 + meson.build | 6 ++++++ meson_options.txt | 2 ++ t/test-lib.sh | 4 ++++ 6 files changed, 19 insertions(+) diff --git a/GIT-BUILD-OPTIONS.in b/GIT-BUILD-OPTIONS.in index f651116102..f1d0ecf123 100644 --- a/GIT-BUILD-OPTIONS.in +++ b/GIT-BUILD-OPTIONS.in @@ -45,3 +45,4 @@ GITWEBDIR=@GITWEBDIR@ USE_GETTEXT_SCHEME=@USE_GETTEXT_SCHEME@ LOCALEDIR=@LOCALEDIR@ BROKEN_PATH_FIX=@BROKEN_PATH_FIX@ +WITH_BREAKING_CHANGES=@WITH_BREAKING_CHANGES@ diff --git a/Makefile b/Makefile index 06f01149ec..dc3c980aa7 100644 --- a/Makefile +++ b/Makefile @@ -2230,6 +2230,10 @@ ifdef FSMONITOR_OS_SETTINGS COMPAT_OBJS += compat/fsmonitor/fsm-path-utils-$(FSMONITOR_OS_SETTINGS).o endif +ifdef WITH_BREAKING_CHANGES + BASIC_CFLAGS += -DWITH_BREAKING_CHANGES +endif + ifeq ($(TCLTK_PATH),) NO_TCLTK = NoThanks endif @@ -3187,6 +3191,7 @@ GIT-BUILD-OPTIONS: FORCE -e "s|@USE_GETTEXT_SCHEME@|\'$(USE_GETTEXT_SCHEME)\'|" \ -e "s|@LOCALEDIR@|\'$(localedir_SQ)\'|" \ -e "s!@BROKEN_PATH_FIX@!\'$(BROKEN_PATH_FIX)\'!" \ + -e "s|@WITH_BREAKING_CHANGES@|\'$(WITH_BREAKING_CHANGES)\'|" \ GIT-BUILD-OPTIONS.in >$@+ @if grep -q '^[A-Z][A-Z_]*=@.*@$$' $@+; then echo "Unsubstituted build options in $@" >&2 && exit 1; fi @if cmp $@+ $@ >/dev/null 2>&1; then $(RM) $@+; else mv $@+ $@; fi diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt index 49904ca8a9..63d0088928 100644 --- a/contrib/buildsystems/CMakeLists.txt +++ b/contrib/buildsystems/CMakeLists.txt @@ -1198,6 +1198,7 @@ string(REPLACE "@GITWEBDIR@" "'${GITWEBDIR}'" git_build_options "${git_build_opt string(REPLACE "@USE_GETTEXT_SCHEME@" "" git_build_options "${git_build_options}") string(REPLACE "@LOCALEDIR@" "'${LOCALEDIR}'" git_build_options "${git_build_options}") string(REPLACE "@BROKEN_PATH_FIX@" "" git_build_options "${git_build_options}") +string(REPLACE "@WITH_BREAKING_CHANGES@" "" git_build_options "${git_build_options}") if(USE_VCPKG) string(APPEND git_build_options "PATH=\"$PATH:$TEST_DIRECTORY/../compat/vcbuild/vcpkg/installed/x64-windows/bin\"\n") endif() diff --git a/meson.build b/meson.build index 0dccebcdf1..316cd93264 100644 --- a/meson.build +++ b/meson.build @@ -644,6 +644,12 @@ build_options_config.set('GIT_TEST_UTF8_LOCALE', '') build_options_config.set_quoted('LOCALEDIR', fs.as_posix(get_option('prefix') / get_option('localedir'))) build_options_config.set('GITWEBDIR', fs.as_posix(get_option('prefix') / get_option('datadir') / 'gitweb')) +if get_option('breaking_changes') + build_options_config.set('WITH_BREAKING_CHANGES', 'YesPlease') +else + build_options_config.set('WITH_BREAKING_CHANGES', '') +endif + if get_option('sane_tool_path') != '' build_options_config.set_quoted('BROKEN_PATH_FIX', 's|^\# @BROKEN_PATH_FIX@$|git_broken_path_fix "' + get_option('sane_tool_path') + '"|') else diff --git a/meson_options.txt b/meson_options.txt index 32a72139ba..800e518d95 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -43,6 +43,8 @@ option('sha256_backend', type: 'combo', choices: ['openssl', 'nettle', 'gcrypt', description: 'The backend used for hashing objects with the SHA256 object format') # Build tweaks. +option('breaking_changes', type: 'boolean', value: false, + description: 'Enable upcoming breaking changes.') option('macos_use_homebrew_gettext', type: 'boolean', value: true, description: 'Use gettext from Homebrew instead of the slightly-broken system-provided one.') diff --git a/t/test-lib.sh b/t/test-lib.sh index 62dfcc4aaf..6e423f655d 100644 --- a/t/test-lib.sh +++ b/t/test-lib.sh @@ -1864,6 +1864,10 @@ test_lazy_prereq CURL ' curl --version ' +test_lazy_prereq WITHOUT_BREAKING_CHANGES ' + test -z "$WITH_BREAKING_CHANGES" +' + # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests # which will not work with other hash algorithms and tests that work but don't # test anything meaningful (e.g. special values which cause short collisions). -- 2.48.0.257.gd3603152ad.dirty ``` ## Patrick Steinhardt, 2025-01-20 07:42 Subject: [PATCH v3 2/5] ci: merge linux-gcc-default into linux-gcc Message-ID: <20250120-pks-remote-branches-deprecation-v3-2-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-2-c7e539b6a84f%40pks.im In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> ``` The "linux-gcc-default" job is mostly doing the same as the "linux-gcc" job, except for a couple of minor differences: - We use an explicit GCC version instead of the default version provided by the distribution. We have other jobs that test with "gcc-8", making this distinction pointless. - We don't set up the Python version explicitly, and instead use the default Python version. Python 2 has been end-of-life for quite a while now though, making this distinction less interesting. - We set up the default branch name to be "main" in "linux-gcc". We have other testcases that don't and also some that explicitly use "master". - We use "ubuntu:20.04" in one job and "ubuntu:latest" in another. We already have a couple other jobs testing these respectively. So overall, the job does not add much to our test coverage. Drop the "linux-gcc-default" job and adapt "linux-gcc" to start using the default GCC compiler, effectively merging those two jobs into one. Signed-off-by: Patrick Steinhardt --- .github/workflows/main.yml | 4 ---- .gitlab-ci.yml | 4 ---- ci/lib.sh | 5 ----- 3 files changed, 13 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 808ddc19b8..32d35d2257 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -271,7 +271,6 @@ jobs: pool: ubuntu-latest - jobname: linux-gcc cc: gcc - cc_package: gcc-8 pool: ubuntu-20.04 - jobname: linux-TEST-vars cc: gcc @@ -286,9 +285,6 @@ jobs: - jobname: osx-gcc cc: gcc-13 pool: macos-13 - - jobname: linux-gcc-default - cc: gcc - pool: ubuntu-latest - jobname: linux-leaks cc: gcc pool: ubuntu-latest diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a1bc92893f..b86bb0bdb3 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -46,14 +46,10 @@ test:linux: - jobname: linux-gcc image: ubuntu:20.04 CC: gcc - CC_PACKAGE: gcc-8 - jobname: linux-TEST-vars image: ubuntu:20.04 CC: gcc CC_PACKAGE: gcc-8 - - jobname: linux-gcc-default - image: ubuntu:latest - CC: gcc - jobname: linux-leaks image: ubuntu:latest CC: gcc diff --git a/ci/lib.sh b/ci/lib.sh index 930f98d722..e67c481d4f 100755 --- a/ci/lib.sh +++ b/ci/lib.sh @@ -328,11 +328,6 @@ export SKIP_DASHED_BUILT_INS=YesPlease case "$distro" in ubuntu-*) - if test "$jobname" = "linux-gcc-default" - then - break - fi - # Python 2 is end of life, and Ubuntu 23.04 and newer don't actually # have it anymore. We thus only test with Python 2 on older LTS # releases. -- 2.48.0.257.gd3603152ad.dirty ``` ## Patrick Steinhardt, 2025-01-20 07:43 Subject: [PATCH v3 3/5] ci: repurpose "linux-gcc" job for deprecations Message-ID: <20250120-pks-remote-branches-deprecation-v3-3-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-3-c7e539b6a84f%40pks.im In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> ``` The "linux-gcc" job isn't all that interesting by itself and can be considered more or less the "standard" job: it is running with a reasonably up-to-date image and uses GCC as a compiler, both of which we already cover in other jobs. There is one exception though: we change the default branch to be "main" instead of "master", so it is forging ahead a bit into the future to make sure that this change does not cause havoc. So let's expand on this a bit and also add the new "WITH_BREAKING_CHANGES" flag to the mix. Rename the job to "linux-breaking-changes" accordingly. Signed-off-by: Patrick Steinhardt --- .github/workflows/main.yml | 2 +- .gitlab-ci.yml | 2 +- ci/run-build-and-tests.sh | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 32d35d2257..46b96fb96c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -269,7 +269,7 @@ jobs: - jobname: linux-reftable cc: clang pool: ubuntu-latest - - jobname: linux-gcc + - jobname: linux-breaking-changes cc: gcc pool: ubuntu-20.04 - jobname: linux-TEST-vars diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b86bb0bdb3..492e5d9082 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -43,7 +43,7 @@ test:linux: - jobname: linux-reftable image: ubuntu:latest CC: clang - - jobname: linux-gcc + - jobname: linux-breaking-changes image: ubuntu:20.04 CC: gcc - jobname: linux-TEST-vars diff --git a/ci/run-build-and-tests.sh b/ci/run-build-and-tests.sh index 2e28d02b20..2ccd812fb4 100755 --- a/ci/run-build-and-tests.sh +++ b/ci/run-build-and-tests.sh @@ -13,8 +13,9 @@ esac run_tests=t case "$jobname" in -linux-gcc) +linux-breaking-changes) export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main + export WITH_BREAKING_CHANGES=YesPlease ;; linux-TEST-vars) export GIT_TEST_SPLIT_INDEX=yes -- 2.48.0.257.gd3603152ad.dirty ``` ## Patrick Steinhardt, 2025-01-20 07:43 Subject: [PATCH v3 4/5] builtin/pack-redundant: remove subcommand with breaking changes Message-ID: <20250120-pks-remote-branches-deprecation-v3-4-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-4-c7e539b6a84f%40pks.im In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> ``` The git-pack-redundant(1) subcommand has been announced for removal with 53a92c9552 (Documentation/BreakingChanges: announce removal of git-pack-redundant(1), 2024-09-02). Stop compiling the subcommand in case the `WITH_BREAKING_CHANGES` build flag is set. Signed-off-by: Patrick Steinhardt --- Makefile | 2 ++ git.c | 2 ++ t/t5323-pack-redundant.sh | 6 ++++++ 3 files changed, 10 insertions(+) diff --git a/Makefile b/Makefile index dc3c980aa7..e6b0d85980 100644 --- a/Makefile +++ b/Makefile @@ -1278,7 +1278,9 @@ BUILTIN_OBJS += builtin/mv.o BUILTIN_OBJS += builtin/name-rev.o BUILTIN_OBJS += builtin/notes.o BUILTIN_OBJS += builtin/pack-objects.o +ifndef WITH_BREAKING_CHANGES BUILTIN_OBJS += builtin/pack-redundant.o +endif BUILTIN_OBJS += builtin/pack-refs.o BUILTIN_OBJS += builtin/patch-id.o BUILTIN_OBJS += builtin/prune-packed.o diff --git a/git.c b/git.c index 46b3c740c5..a13c32bcdc 100644 --- a/git.c +++ b/git.c @@ -589,7 +589,9 @@ static struct cmd_struct commands[] = { { "name-rev", cmd_name_rev, RUN_SETUP }, { "notes", cmd_notes, RUN_SETUP }, { "pack-objects", cmd_pack_objects, RUN_SETUP }, +#ifndef WITH_BREAKING_CHANGES { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT }, +#endif { "pack-refs", cmd_pack_refs, RUN_SETUP }, { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT }, { "pickaxe", cmd_blame, RUN_SETUP }, diff --git a/t/t5323-pack-redundant.sh b/t/t5323-pack-redundant.sh index 8dbbcc5e51..688cd9706c 100755 --- a/t/t5323-pack-redundant.sh +++ b/t/t5323-pack-redundant.sh @@ -36,6 +36,12 @@ relationship between packs and objects is as follows: . ./test-lib.sh +if ! test_have_prereq WITHOUT_BREAKING_CHANGES +then + skip_all='skipping git-pack-redundant tests; built with breaking changes' + test_done +fi + main_repo=main.git shared_repo=shared.git -- 2.48.0.257.gd3603152ad.dirty ``` ## Patrick Steinhardt, 2025-01-20 07:43 Subject: [PATCH v3 5/5] remote: announce removal of "branches/" and "remotes/" Message-ID: <20250120-pks-remote-branches-deprecation-v3-5-c7e539b6a84f@pks.im> URL: https://gitlist.dev/e/20250120-pks-remote-branches-deprecation-v3-5-c7e539b6a84f%40pks.im In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-0-c7e539b6a84f@pks.im> ``` Back when Git was in its infancy, remotes were configured via separate files in "branches/" (back in 2005). This mechanism was replaced later that year with the "remotes/" directory. Both mechanisms have eventually been replaced by config-based remotes, and it is very unlikely that anybody still uses these directories to configure their remotes. Both of these directories have been marked as deprecated, one in 2005 and the other one in 2011. Follow through with the deprecation and finally announce the removal of these features in Git 3.0. Signed-off-by: Patrick Steinhardt --- Documentation/BreakingChanges.txt | 25 ++++++++++++++++++ Documentation/gitrepository-layout.txt | 7 +++-- builtin/remote.c | 2 ++ remote.c | 19 ++++++++++++++ remote.h | 2 ++ t/t5505-remote.sh | 6 ++--- t/t5510-fetch.sh | 13 ++++------ t/t5515-fetch-merge-logic.sh | 47 ++++++++++++++++++---------------- t/t5516-fetch-push.sh | 14 +++++----- 9 files changed, 92 insertions(+), 43 deletions(-) diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt index 27acff86db..a91eb3bc55 100644 --- a/Documentation/BreakingChanges.txt +++ b/Documentation/BreakingChanges.txt @@ -154,6 +154,31 @@ Cf. , , <20230323204047.GA9290@coredump.intra.peff.net>, +* Support for storing shorthands for remote URLs in "$GIT_COMMON_DIR/branches/" + and "$GIT_COMMON_DIR/remotes/" has been long superseded by storing remotes in + the repository configuration. ++ +The mechanism has originally been introduced in f170e4b39d ([PATCH] fetch/pull: +short-hand notation for remote repositories., 2005-07-16) and was superseded by +6687f8fea2 ([PATCH] Use .git/remote/origin, not .git/branches/origin., +2005-08-20), where we switched from ".git/branches/" to ".git/remotes/". That +commit already mentions an upcoming deprecation of the ".git/branches/" +directory, and starting with a1d4aa7424 (Add repository-layout document., +2005-09-01) we have also marked this layout as deprecated. Eventually we also +started to migrate away from ".git/remotes/" in favor of config-based remotes, +and we have marked the directory as legacy in 3d3d282146 (Documentation: +Grammar correction, wording fixes and cleanup, 2011-08-23) ++ +As our documentation mentions, these directories are not to be found in modern +repositories at all and most users aren't even aware of these mechanisms. They +have been deprecated for almost 20 years and 14 years respectively, and we are +not aware of any reason why anybody would want to use these mechanisms. +Furthermore, the ".git/branches/" directory is nowadays misleadingly named and +may cause confusion as "branches" are almost exclusively used in the context of +references. ++ +These features will be removed. + == Superseded features that will not be deprecated Some features have gained newer replacements that aim to improve the design in diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index fa8b51daf0..85911ca8ea 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -153,7 +153,7 @@ config.worktree:: linkgit:git-worktree[1]). branches:: - A slightly deprecated way to store shorthands to be used + A deprecated way to store shorthands to be used to specify a URL to 'git fetch', 'git pull' and 'git push'. A file can be stored as `branches/` and then 'name' can be given to these commands in place of @@ -162,7 +162,8 @@ branches:: and not likely to be found in modern repositories. This directory is ignored if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/branches" will be used instead. - ++ +Git will stop reading remotes from this directory in Git 3.0. hooks:: Hooks are customization scripts used by various Git @@ -238,6 +239,8 @@ remotes:: and not likely to be found in modern repositories. This directory is ignored if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/remotes" will be used instead. ++ +Git will stop reading remotes from this directory in Git 3.0. logs:: Records of changes made to refs are stored in this directory. diff --git a/builtin/remote.c b/builtin/remote.c index 1ad3e70a6b..e565b2b3fe 100644 --- a/builtin/remote.c +++ b/builtin/remote.c @@ -640,10 +640,12 @@ static int migrate_file(struct remote *remote) strbuf_addf(&buf, "remote.%s.fetch", remote->name); for (i = 0; i < remote->fetch.nr; i++) git_config_set_multivar(buf.buf, remote->fetch.items[i].raw, "^$", 0); +#ifndef WITH_BREAKING_CHANGES if (remote->origin == REMOTE_REMOTES) unlink_or_warn(git_path("remotes/%s", remote->name)); else if (remote->origin == REMOTE_BRANCHES) unlink_or_warn(git_path("branches/%s", remote->name)); +#endif /* WITH_BREAKING_CHANGES */ strbuf_release(&buf); return 0; diff --git a/remote.c b/remote.c index 10104d11e3..5feb0ae886 100644 --- a/remote.c +++ b/remote.c @@ -293,6 +293,7 @@ static void add_instead_of(struct rewrite *rewrite, const char *instead_of) rewrite->instead_of_nr++; } +#ifndef WITH_BREAKING_CHANGES static const char *skip_spaces(const char *s) { while (isspace(*s)) @@ -308,6 +309,13 @@ static void read_remotes_file(struct remote_state *remote_state, if (!f) return; + + warning(_("Reading remote from \"remotes/%s\", which is nominated\n" + "for removal. If you still use the \"remotes/\" directory\n" + "it is recommended to migrate to config-based remotes. If\n" + "you cannot, please let us know you still use it by sending\n" + "an e-mail to ."), remote->name); + remote->configured_in_repo = 1; remote->origin = REMOTE_REMOTES; while (strbuf_getline(&buf, f) != EOF) { @@ -337,6 +345,12 @@ static void read_branches_file(struct remote_state *remote_state, if (!f) return; + warning(_("Reading remote from \"branches/%s\", which is nominated\n" + "for removal. If you still use the \"branches/\" directory\n" + "it is recommended to migrate to config-based remotes. If\n" + "you cannot, please let us know you still use it by sending\n" + "an e-mail to ."), remote->name); + strbuf_getline_lf(&buf, f); fclose(f); strbuf_trim(&buf); @@ -374,6 +388,7 @@ static void read_branches_file(struct remote_state *remote_state, strbuf_release(&buf); free(to_free); } +#endif /* WITH_BREAKING_CHANGES */ static int handle_config(const char *key, const char *value, const struct config_context *ctx, void *cb) @@ -572,6 +587,7 @@ static void read_config(struct repository *repo, int early) alias_all_urls(repo->remote_state); } +#ifndef WITH_BREAKING_CHANGES static int valid_remote_nick(const char *name) { if (!name[0] || is_dot_or_dotdot(name)) @@ -583,6 +599,7 @@ static int valid_remote_nick(const char *name) return 0; return 1; } +#endif /* WITH_BREAKING_CHANGES */ static const char *remotes_remote_for_branch(struct remote_state *remote_state, struct branch *branch, @@ -725,12 +742,14 @@ remotes_remote_get_1(struct remote_state *remote_state, const char *name, &name_given); ret = make_remote(remote_state, name, 0); +#ifndef WITH_BREAKING_CHANGES if (valid_remote_nick(name) && have_git_dir()) { if (!valid_remote(ret)) read_remotes_file(remote_state, ret); if (!valid_remote(ret)) read_branches_file(remote_state, ret); } +#endif /* WITH_BREAKING_CHANGES */ if (name_given && !valid_remote(ret)) add_url_alias(remote_state, ret, name); if (!valid_remote(ret)) diff --git a/remote.h b/remote.h index a7e5c4e07c..45b0c9babb 100644 --- a/remote.h +++ b/remote.h @@ -21,8 +21,10 @@ struct transport_ls_refs_options; enum { REMOTE_UNCONFIGURED = 0, REMOTE_CONFIG, +#ifndef WITH_BREAKING_CHANGES REMOTE_REMOTES, REMOTE_BRANCHES +#endif /* WITH_BREAKING_CHANGES */ }; struct rewrite { diff --git a/t/t5505-remote.sh b/t/t5505-remote.sh index 08424e878e..e96ac8c767 100755 --- a/t/t5505-remote.sh +++ b/t/t5505-remote.sh @@ -1007,7 +1007,7 @@ Pull: refs/heads/main:refs/heads/origin Pull: refs/heads/next:refs/heads/origin2 EOF -test_expect_success 'migrate a remote from named file in $GIT_DIR/remotes' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'migrate a remote from named file in $GIT_DIR/remotes' ' git clone one five && origin_url=$(pwd)/one && ( @@ -1033,7 +1033,7 @@ test_expect_success 'migrate a remote from named file in $GIT_DIR/remotes' ' ) ' -test_expect_success 'migrate a remote from named file in $GIT_DIR/branches' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'migrate a remote from named file in $GIT_DIR/branches' ' git clone --template= one six && origin_url=$(pwd)/one && ( @@ -1049,7 +1049,7 @@ test_expect_success 'migrate a remote from named file in $GIT_DIR/branches' ' ) ' -test_expect_success 'migrate a remote from named file in $GIT_DIR/branches (2)' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'migrate a remote from named file in $GIT_DIR/branches (2)' ' git clone --template= one seven && ( cd seven && diff --git a/t/t5510-fetch.sh b/t/t5510-fetch.sh index 3b3991ab86..04d8a96367 100755 --- a/t/t5510-fetch.sh +++ b/t/t5510-fetch.sh @@ -34,14 +34,11 @@ test_expect_success "clone and setup child repos" ' git clone . three && ( cd three && - git config branch.main.remote two && - git config branch.main.merge refs/heads/one && - mkdir -p .git/remotes && - cat >.git/remotes/two <<-\EOF - URL: ../two/.git/ - Pull: refs/heads/main:refs/heads/two - Pull: refs/heads/one:refs/heads/one - EOF + git config set remote.two.url ../two/.git/ && + git config set remote.two.fetch refs/heads/main:refs/heads/two && + git config set --append remote.two.fetch refs/heads/one:refs/heads/one && + git config set branch.main.remote two && + git config set branch.main.merge refs/heads/one ) && git clone . bundle && git clone . seven diff --git a/t/t5515-fetch-merge-logic.sh b/t/t5515-fetch-merge-logic.sh index 320d26796d..4e6026c611 100755 --- a/t/t5515-fetch-merge-logic.sh +++ b/t/t5515-fetch-merge-logic.sh @@ -104,28 +104,31 @@ test_expect_success setup ' git config remote.config-glob.fetch refs/heads/*:refs/remotes/rem/* && remotes="$remotes config-glob" && - mkdir -p .git/remotes && - cat >.git/remotes/remote-explicit <<-\EOF && - URL: ../.git/ - Pull: refs/heads/main:remotes/rem/main - Pull: refs/heads/one:remotes/rem/one - Pull: two:remotes/rem/two - Pull: refs/heads/three:remotes/rem/three - EOF - remotes="$remotes remote-explicit" && - - cat >.git/remotes/remote-glob <<-\EOF && - URL: ../.git/ - Pull: refs/heads/*:refs/remotes/rem/* - EOF - remotes="$remotes remote-glob" && - - mkdir -p .git/branches && - echo "../.git" > .git/branches/branches-default && - remotes="$remotes branches-default" && - - echo "../.git#one" > .git/branches/branches-one && - remotes="$remotes branches-one" && + if test_have_prereq WITHOUT_BREAKING_CHANGES + then + mkdir -p .git/remotes && + cat >.git/remotes/remote-explicit <<-\EOF && + URL: ../.git/ + Pull: refs/heads/main:remotes/rem/main + Pull: refs/heads/one:remotes/rem/one + Pull: two:remotes/rem/two + Pull: refs/heads/three:remotes/rem/three + EOF + remotes="$remotes remote-explicit" && + + cat >.git/remotes/remote-glob <<-\EOF && + URL: ../.git/ + Pull: refs/heads/*:refs/remotes/rem/* + EOF + remotes="$remotes remote-glob" && + + mkdir -p .git/branches && + echo "../.git" > .git/branches/branches-default && + remotes="$remotes branches-default" && + + echo "../.git#one" > .git/branches/branches-one && + remotes="$remotes branches-one" + fi && for remote in $remotes ; do git config branch.br-$remote.remote $remote && diff --git a/t/t5516-fetch-push.sh b/t/t5516-fetch-push.sh index 9d693eb57f..e705aedbf4 100755 --- a/t/t5516-fetch-push.sh +++ b/t/t5516-fetch-push.sh @@ -975,7 +975,7 @@ test_expect_success 'allow push to HEAD of non-bare repository (config)' ' ! grep "warning: updating the current branch" stderr ' -test_expect_success 'fetch with branches' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'fetch with branches' ' mk_empty testrepo && git branch second $the_first_commit && git checkout second && @@ -991,7 +991,7 @@ test_expect_success 'fetch with branches' ' git checkout main ' -test_expect_success 'fetch with branches containing #' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'fetch with branches containing #' ' mk_empty testrepo && mkdir testrepo/.git/branches && echo "..#second" > testrepo/.git/branches/branch2 && @@ -1005,7 +1005,7 @@ test_expect_success 'fetch with branches containing #' ' git checkout main ' -test_expect_success 'push with branches' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'push with branches' ' mk_empty testrepo && git checkout second && @@ -1022,7 +1022,7 @@ test_expect_success 'push with branches' ' ) ' -test_expect_success 'push with branches containing #' ' +test_expect_success WITHOUT_BREAKING_CHANGES 'push with branches containing #' ' mk_empty testrepo && test_when_finished "rm -rf .git/branches" && @@ -1211,18 +1211,16 @@ test_expect_success 'push --porcelain --dry-run rejected' ' ' test_expect_success 'push --prune' ' - mk_test testrepo heads/main heads/second heads/foo heads/bar && + mk_test testrepo heads/main heads/foo heads/bar && git push --prune testrepo : && check_push_result testrepo $the_commit heads/main && - check_push_result testrepo $the_first_commit heads/second && ! check_push_result testrepo $the_first_commit heads/foo heads/bar ' test_expect_success 'push --prune refspec' ' - mk_test testrepo tmp/main tmp/second tmp/foo tmp/bar && + mk_test testrepo tmp/main tmp/foo tmp/bar && git push --prune testrepo "refs/heads/*:refs/tmp/*" && check_push_result testrepo $the_commit tmp/main && - check_push_result testrepo $the_first_commit tmp/second && ! check_push_result testrepo $the_first_commit tmp/foo tmp/bar ' -- 2.48.0.257.gd3603152ad.dirty ``` ## Junio C Hamano, 2025-01-21 21:09 Subject: Re: [PATCH v3 4/5] builtin/pack-redundant: remove subcommand with breaking changes Message-ID: URL: https://gitlist.dev/e/xmqqed0vzxep.fsf%40gitster.g In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-4-c7e539b6a84f@pks.im> ``` Patrick Steinhardt writes: > The git-pack-redundant(1) subcommand has been announced for removal with > 53a92c9552 (Documentation/BreakingChanges: announce removal of > git-pack-redundant(1), 2024-09-02). Stop compiling the subcommand in > case the `WITH_BREAKING_CHANGES` build flag is set. Nice. The date it was added to BreakingChanges document is probably of much lessor impact and importance to the end users than when we stopped working unless the user gave "--i-still-use-this" which was done by 4406522b (pack-redundant: escalate deprecation warning to an error, 2023-03-23) that was in Git 2.41. Other than that, I love this step. The fewer the subcommands, the happier the users ;-) ``` ## Junio C Hamano, 2025-01-21 21:25 Subject: Re: [PATCH v3 5/5] remote: announce removal of "branches/" and "remotes/" Message-ID: URL: https://gitlist.dev/e/xmqqtt9ryi3f.fsf%40gitster.g In-Reply-To: <20250120-pks-remote-branches-deprecation-v3-5-c7e539b6a84f@pks.im> ``` Patrick Steinhardt writes: > +repositories at all and most users aren't even aware of these mechanisms. They > +have been deprecated for almost 20 years and 14 years respectively, and we are > +not aware of any reason why anybody would want to use these mechanisms. I am aware of one reason why some folks may prefer being able to say $ ls .git/branches/*pattern* $ echo "$URL#branch" >".git/branches/$shortname" $ git fetch $shortname over the configuration file based mechanism, especially when they have to deal with dozens of remotes that change the branch name to be pulled from. And as I already said the above while reviewing the previous round of this series, _we_ are now aware of it. I however am in favor of deprecating and removing the support, but that is not because I am not aware how useful they could be. I am and we are aware, but we haven't heard anybody jumping up and down to advocate for its undeprecation for a long time, and that is why I am personally OK with this removal. > branches:: > - A slightly deprecated way to store shorthands to be used > + A deprecated way to store shorthands to be used > to specify a URL to 'git fetch', 'git pull' and 'git push'. > A file can be stored as `branches/` and then > 'name' can be given to these commands in place of > @@ -162,7 +162,8 @@ branches:: > and not likely to be found in modern repositories. This > directory is ignored if $GIT_COMMON_DIR is set and > "$GIT_COMMON_DIR/branches" will be used instead. > - > ++ > +Git will stop reading remotes from this directory in Git 3.0. > > hooks:: > Hooks are customization scripts used by various Git > @@ -238,6 +239,8 @@ remotes:: > and not likely to be found in modern repositories. This > directory is ignored if $GIT_COMMON_DIR is set and > "$GIT_COMMON_DIR/remotes" will be used instead. > ++ > +Git will stop reading remotes from this directory in Git 3.0. OK. > diff --git a/builtin/remote.c b/builtin/remote.c > index 1ad3e70a6b..e565b2b3fe 100644 > --- a/builtin/remote.c > +++ b/builtin/remote.c > @@ -640,10 +640,12 @@ static int migrate_file(struct remote *remote) > strbuf_addf(&buf, "remote.%s.fetch", remote->name); > for (i = 0; i < remote->fetch.nr; i++) > git_config_set_multivar(buf.buf, remote->fetch.items[i].raw, "^$", 0); > +#ifndef WITH_BREAKING_CHANGES > if (remote->origin == REMOTE_REMOTES) > unlink_or_warn(git_path("remotes/%s", remote->name)); > else if (remote->origin == REMOTE_BRANCHES) > unlink_or_warn(git_path("branches/%s", remote->name)); > +#endif /* WITH_BREAKING_CHANGES */ > strbuf_release(&buf); Interesting. I wonder if our new warning should talk about whatever end-user facing interface that triggers this code path. It would help them wean themselves away from the old interface, no? > diff --git a/remote.c b/remote.c > index 10104d11e3..5feb0ae886 100644 > --- a/remote.c > +++ b/remote.c > @@ -293,6 +293,7 @@ static void add_instead_of(struct rewrite *rewrite, const char *instead_of) > rewrite->instead_of_nr++; > } > > +#ifndef WITH_BREAKING_CHANGES > static const char *skip_spaces(const char *s) > { > while (isspace(*s)) > @@ -308,6 +309,13 @@ static void read_remotes_file(struct remote_state *remote_state, > > if (!f) > return; > + > + warning(_("Reading remote from \"remotes/%s\", which is nominated\n" > + "for removal. If you still use the \"remotes/\" directory\n" > + "it is recommended to migrate to config-based remotes. If\n" Do we have a way to concisely say "how" to do this? If I am reading the caller of migrate_file() in builtin/remote.c, it would be $ git remote mv foo foo for any foo in .git/remotes/* or .git/branches/* hierarchy? Of course they may be an ancient leftover file that the user even no longer is aware of having, in which case $ rm .git/remotes/foo might be an OK answer, but even then $ git remote rm foo would probably be more appropriate. > + "you cannot, please let us know you still use it by sending\n" I do not think we care to receive a piece of e-mail that only says "I still use it". We may want to learn _why_ they cannot switch away, though. The same comment applies to the other side. Everything else in this patch looked superb. Thanks. ``` ## Patrick Steinhardt, 2025-01-22 11:05 Subject: Re: [PATCH v3 5/5] remote: announce removal of "branches/" and "remotes/" Message-ID: URL: https://gitlist.dev/e/Z5DRESPpegE41xaT%40pks.im In-Reply-To: ``` On Tue, Jan 21, 2025 at 01:25:56PM -0800, Junio C Hamano wrote: > Patrick Steinhardt writes: > > diff --git a/builtin/remote.c b/builtin/remote.c > > index 1ad3e70a6b..e565b2b3fe 100644 > > --- a/builtin/remote.c > > +++ b/builtin/remote.c > > @@ -640,10 +640,12 @@ static int migrate_file(struct remote *remote) > > strbuf_addf(&buf, "remote.%s.fetch", remote->name); > > for (i = 0; i < remote->fetch.nr; i++) > > git_config_set_multivar(buf.buf, remote->fetch.items[i].raw, "^$", 0); > > +#ifndef WITH_BREAKING_CHANGES > > if (remote->origin == REMOTE_REMOTES) > > unlink_or_warn(git_path("remotes/%s", remote->name)); > > else if (remote->origin == REMOTE_BRANCHES) > > unlink_or_warn(git_path("branches/%s", remote->name)); > > +#endif /* WITH_BREAKING_CHANGES */ > > strbuf_release(&buf); > > Interesting. I wonder if our new warning should talk about whatever > end-user facing interface that triggers this code path. It would > help them wean themselves away from the old interface, no? Not quite sure that I understand what you're saying. Is it that we should tell whether we were reading from "branches/" or "remotes/"? If so we already do that. > > diff --git a/remote.c b/remote.c > > index 10104d11e3..5feb0ae886 100644 > > --- a/remote.c > > +++ b/remote.c > > @@ -293,6 +293,7 @@ static void add_instead_of(struct rewrite *rewrite, const char *instead_of) > > rewrite->instead_of_nr++; > > } > > > > +#ifndef WITH_BREAKING_CHANGES > > static const char *skip_spaces(const char *s) > > { > > while (isspace(*s)) > > @@ -308,6 +309,13 @@ static void read_remotes_file(struct remote_state *remote_state, > > > > if (!f) > > return; > > + > > + warning(_("Reading remote from \"remotes/%s\", which is nominated\n" > > + "for removal. If you still use the \"remotes/\" directory\n" > > + "it is recommended to migrate to config-based remotes. If\n" > > Do we have a way to concisely say "how" to do this? If I am reading > the caller of migrate_file() in builtin/remote.c, it would be > > $ git remote mv foo foo > > for any foo in .git/remotes/* or .git/branches/* hierarchy? > > Of course they may be an ancient leftover file that the user even no > longer is aware of having, in which case > > $ rm .git/remotes/foo > > might be an OK answer, but even then > > $ git remote rm foo > > would probably be more appropriate. Very good idea indeed. We also have tests that exercise this behaviour in t5505 (with the slight exception that it is `git remote rename`, not `git remote mv`). Patrick ``` ## Junio C Hamano, 2025-01-22 17:58 Subject: Re: [PATCH v3 5/5] remote: announce removal of "branches/" and "remotes/" Message-ID: URL: https://gitlist.dev/e/xmqqo6zywx1c.fsf%40gitster.g In-Reply-To: ``` Patrick Steinhardt writes: > On Tue, Jan 21, 2025 at 01:25:56PM -0800, Junio C Hamano wrote: >> Patrick Steinhardt writes: >> > diff --git a/builtin/remote.c b/builtin/remote.c >> > index 1ad3e70a6b..e565b2b3fe 100644 >> > --- a/builtin/remote.c >> > +++ b/builtin/remote.c >> > @@ -640,10 +640,12 @@ static int migrate_file(struct remote *remote) >> > strbuf_addf(&buf, "remote.%s.fetch", remote->name); >> > for (i = 0; i < remote->fetch.nr; i++) >> > git_config_set_multivar(buf.buf, remote->fetch.items[i].raw, "^$", 0); >> > +#ifndef WITH_BREAKING_CHANGES >> > if (remote->origin == REMOTE_REMOTES) >> > unlink_or_warn(git_path("remotes/%s", remote->name)); >> > else if (remote->origin == REMOTE_BRANCHES) >> > unlink_or_warn(git_path("branches/%s", remote->name)); >> > +#endif /* WITH_BREAKING_CHANGES */ >> > strbuf_release(&buf); >> >> Interesting. I wonder if our new warning should talk about whatever >> end-user facing interface that triggers this code path. It would >> help them wean themselves away from the old interface, no? > > Not quite sure that I understand what you're saying. Is it that we > should tell whether we were reading from "branches/" or "remotes/"? If > so we already do that. No, what I meant was to say "You are using outdated remotes/ hierarchy to describe this remote. You can run 'remote mv %s %s' to migrate its definition to the more modern config-based system". The message already says the first sentence, but not the latter. ```