Re: [PATCH 1/4] doc: git-push: update intro
- From
D. Ben Knoble <ben.knoble@gmail.com>
- Date
- Aug 28, 2025, 13:53 UTC
- Message-ID
- <CALnO6CCca2Yp7K16ShqUaZNN_POv106qyXfKq1aJMyXhA+EyCw@mail.gmail.com>
- In-Reply-To
- <2fa98fb5cae78b8872d0b864ee246ba619ef631b.1756240823.git.gitgitgadget@gmail.com>
On Tue, Aug 26, 2025 at 4:40 PM Julia Evans via GitGitGadget <gitgitgadget@gmail.com> wrote:
> > From: Julia Evans <julia@jvns.ca> > > - Users don't understand what a "ref" is, expand it
[snip]
Show 16 quoted lines
> diff --git a/Documentation/git-push.adoc b/Documentation/git-push.adoc > index d1978650d60a..e73b64f61fd0 100644 > --- a/Documentation/git-push.adoc > +++ b/Documentation/git-push.adoc > @@ -19,12 +19,8 @@ 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.
Considering the glossary entry[1] is for "ref", not "reference", what about
(a) linking to the glossary (is this possible?), and/or (b) saying something like
Updates one or more branches, tags, or other references (called "refs")…
?
[1]: "git help glossary", or https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-ref
Show 10 quoted lines
> > When the command line does not specify where to push with the > `<repository>` argument, `branch.*.remote` configuration for the > @@ -44,6 +40,9 @@ 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].
Seems reasonable to me. Thanks!
-- D. Ben Knoble