From c5f8f607191c55e360cee8a23aa6b722e4d8dd65 Mon Sep 17 00:00:00 2001 From: Matthias Goergens Date: Tue, 29 Sep 2026 20:00:10 +0800 Subject: [PATCH] doc: remote: say that it only affects the local repository Nothing that "git remote" does changes a remote repository. "set-head" updates the local refs/remotes//HEAD, not the remote's own HEAD; "prune" deletes stale remote-tracking branches, not branches on the remote; and so on. The manual page never says so, and wording such as "Set or delete the default branch ... for the named remote" can be read as acting on the remote itself. It was recently misread that way in a discussion on another project's mailing list. Say it once, near the top of the DESCRIPTION, rather than in the description of each subcommand. Signed-off-by: Matthias Goergens Signed-off-by: Junio C Hamano --- Documentation/git-remote.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/git-remote.adoc b/Documentation/git-remote.adoc index eaae30aa88..315100409d 100644 --- a/Documentation/git-remote.adoc +++ b/Documentation/git-remote.adoc @@ -28,6 +28,11 @@ DESCRIPTION Manage the set of repositories ("remotes") whose branches you track. +`git remote` changes only the local repository, i.e. its configuration +and its refs, and never modifies a remote repository. Some subcommands, +such as `show`, `prune`, `update` and `set-head --auto`, contact a +remote repository to read from it. + OPTIONS -------