diff mbox series

Documentation: Mention that refspecs are explained elsewhere

Message ID 20240506182317.13477-1-oystwa@gmail.com (mailing list archive)
State Accepted
Commit 0b8bd1959eafaf42d51599db264dec4090e7ee8a
Headers show
Series Documentation: Mention that refspecs are explained elsewhere | expand

Commit Message

Øystein Walle May 6, 2024, 6:23 p.m. UTC
The syntax for refspecs are explained in more detail in documention for
git-fetch and git-push. Give a hint to the user too look there more fore
information

Signed-off-by: Øystein Walle <oystwa@gmail.com>
---
 Documentation/glossary-content.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Junio C Hamano May 6, 2024, 7:12 p.m. UTC | #1
Øystein Walle <oystwa@gmail.com> writes:

> The syntax for refspecs are explained in more detail in documention for
> git-fetch and git-push. Give a hint to the user too look there more fore
> information

Sounds sensible.  It is a bit unsatisfying that we cannot make the
glossary entry the single source of the authoritative truth, but the
refspec syntax needs to be slightly different between fetches and
pushes (hence Documention/git-push.txt does not include the same
Documentation/pull-fetch-param.txt like Documentation/git-fetch.txt
does), so this is probably the best we could do.

> Signed-off-by: Øystein Walle <oystwa@gmail.com>
> ---
>  Documentation/glossary-content.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index d71b199955..1272809e13 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -576,7 +576,8 @@ The most notable example is `HEAD`.
>  [[def_refspec]]refspec::
>  	A "refspec" is used by <<def_fetch,fetch>> and
>  	<<def_push,push>> to describe the mapping between remote
> -	<<def_ref,ref>> and local ref.
> +	<<def_ref,ref>> and local ref. See linkgit:git-fetch[1] or
> +	linkgit:git-push[1] for details.

Will queue.  Thanks.
diff mbox series

Patch

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index d71b199955..1272809e13 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -576,7 +576,8 @@  The most notable example is `HEAD`.
 [[def_refspec]]refspec::
 	A "refspec" is used by <<def_fetch,fetch>> and
 	<<def_push,push>> to describe the mapping between remote
-	<<def_ref,ref>> and local ref.
+	<<def_ref,ref>> and local ref. See linkgit:git-fetch[1] or
+	linkgit:git-push[1] for details.
 
 [[def_remote]]remote repository::
 	A <<def_repository,repository>> which is used to track the same