[v3,0/5] remote: announce removal of "branches/" and "remotes/"

Message

Patrick Steinhardt Jan. 20, 2025, 7:42 a.m. UTC

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/[e-mail]

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/[e-mail]

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 <[e-mail]>
     
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 <[e-mail]>
     
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 <[e-mail]>."), 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 <[e-mail]>."), 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