Re: [PATCH v2] doc: remote: say that it only affects the local repository

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 29, 2026, 16:28 UTC
Message-ID: <xmqqld8khviu.fsf@gitster.g>
In-Reply-To: <20260929120010.840402-1-matthias.goergens@gmail.com>

Matthias Goergens <matthias.goergens@gmail.com> writes:

Show 13 quoted lines

> 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.
> +

I would not have minded having additional text in descriptions for individual operations like 'set-head' and 'prune' that might be misread to work on the other side, but the description above is very clear and we may not need anything extra.

I also like the second sentence, mentioning that some commands read from the remote. It implicitly stresses that nobody writes to the remote.

Thanks.