diff options
| author | Julia Evans <julia@jvns.ca> | 2025-10-06 18:58:47 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-10-06 14:29:48 -0700 |
| commit | 5b696cb390385f4906df411be917ef0a7b92ebb7 (patch) | |
| tree | b7c4a27fc3887a7e10bc246e34928aa5bc024d64 | |
| parent | 92c87bdc406e5bcf1b516a861d609b03d99c23b7 (diff) | |
doc: git-push: clarify intro
From user feedback, 5 users are unsure what "ref" and/or "objects" means
in this context. 3 users said they don't know what "complete the refs"
means.
Many users also commented that receive hooks do not seem like the most
important thing to know about `git push`, and that this information
should not be the second sentence in the man page.
Use more familiar language to make it more accessible to users who do
not know what a "ref" is and move the "hooks" comment to the end.
Signed-off-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-push.adoc | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/git-push.adoc b/Documentation/git-push.adoc index 5f5408e2c0..2b7f7de9dd 100644 --- a/Documentation/git-push.adoc +++ b/Documentation/git-push.adoc @@ -19,12 +19,9 @@ SYNOPSIS DESCRIPTION ----------- -Updates remote refs using local refs, while sending objects -necessary to complete the given refs. - -You can make interesting things happen to a repository -every time you push into it, by setting up 'hooks' there. See -documentation for linkgit:git-receive-pack[1]. +Updates one or more branches, tags, or other references in a remote +repository from your local repository, and sends all necessary data +that isn't already on the remote. When the command line does not specify where to push with the `<repository>` argument, `branch.*.remote` configuration for the @@ -44,6 +41,10 @@ corresponding upstream branch, but as a safety measure, the push is aborted if the upstream branch does not have the same name as the local one. +You can make interesting things happen to a repository +every time you push into it, by setting up 'hooks' there. See +documentation for linkgit:git-receive-pack[1]. + OPTIONS[[OPTIONS]] ------------------ |
