git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jacob Keller <jacob.e.keller@intel.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>,
	Jacob Keller <jacob.keller@gmail.com>
Subject: Re: [RFC 1/3] refspec: fix documentation referring to refspec_item
Date: Mon, 17 Aug 2020 09:18:37 -0700	[thread overview]
Message-ID: <xmqqk0xx455u.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200815002509.2467645-1-jacob.e.keller@intel.com> (Jacob Keller's message of "Fri, 14 Aug 2020 17:25:07 -0700")

Jacob Keller <jacob.e.keller@intel.com> writes:

> From: Jacob Keller <jacob.keller@gmail.com>
>
> In commit d27eb356bf25 ("remote: move doc to remote.h and refspec.h")
> the documentation for the refspec structure was moved into refspec.h
>
> This documentation refers to elements of the refspec_item, not the
> struct refspec. Move the documentation slightly in order to align it
> with the structure it is actually referring to.

Makes sense to me.

>
> Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
> ---
>  refspec.h | 27 ++++++++++++++-------------
>  1 file changed, 14 insertions(+), 13 deletions(-)
>
> diff --git a/refspec.h b/refspec.h
> index 23e1555b88ac..8d654e3a3ac4 100644
> --- a/refspec.h
> +++ b/refspec.h
> @@ -4,6 +4,19 @@
>  #define TAG_REFSPEC "refs/tags/*:refs/tags/*"
>  extern const struct refspec_item *tag_refspec;
>  
> +/**
> + * A struct refspec_item holds the parsed interpretation of a refspec.  If it will
> + * force updates (starts with a '+'), force is true.  If it is a pattern
> + * (sides end with '*') pattern is true.  src and dest are the two sides
> + * (including '*' characters if present); if there is only one side, it is src,
> + * and dst is NULL; if sides exist but are empty (i.e., the refspec either
> + * starts or ends with ':'), the corresponding side is "".
> + *
> + * remote_find_tracking(), given a remote and a struct refspec_item with either src
> + * or dst filled out, will fill out the other such that the result is in the
> + * "fetch" specification for the remote (note that this evaluates patterns and
> + * returns a single result).
> + */
>  struct refspec_item {
>  	unsigned force : 1;
>  	unsigned pattern : 1;
> @@ -21,20 +34,8 @@ struct refspec_item {
>  #define REFSPEC_INIT_PUSH { .fetch = REFSPEC_PUSH }
>  
>  /**
> - * A struct refspec holds the parsed interpretation of a refspec.  If it will
> - * force updates (starts with a '+'), force is true.  If it is a pattern
> - * (sides end with '*') pattern is true.  src and dest are the two sides
> - * (including '*' characters if present); if there is only one side, it is src,
> - * and dst is NULL; if sides exist but are empty (i.e., the refspec either
> - * starts or ends with ':'), the corresponding side is "".
> - *
> - * An array of strings can be parsed into an array of struct refspecs using
> + * An array of strings can be parsed into a struct refspec using
>   * parse_fetch_refspec() or parse_push_refspec().
> - *
> - * remote_find_tracking(), given a remote and a struct refspec with either src
> - * or dst filled out, will fill out the other such that the result is in the
> - * "fetch" specification for the remote (note that this evaluates patterns and
> - * returns a single result).
>   */
>  struct refspec {
>  	struct refspec_item *items;
>
> base-commit: 878e727637ec5815ccb3301eb994a54df95b21b8

  parent reply	other threads:[~2020-08-17 16:21 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-15  0:25 Jacob Keller
2020-08-15  0:25 ` [RFC 2/3] refspec: make sure stack refspec_item variables are zeroed Jacob Keller
2020-08-17 16:33   ` Junio C Hamano
2020-08-17 16:49     ` Jacob Keller
2020-08-15  0:25 ` [RFC 3/3] refspec: add support for negative refspecs Jacob Keller
2020-08-17 18:02   ` Jacob Keller
2020-08-17 23:43   ` Junio C Hamano
2020-08-18  0:04     ` Jacob Keller
2020-08-18 17:41       ` Jeff King
2020-08-20 23:59         ` Jacob Keller
2020-08-21  2:33           ` Jeff King
2020-08-21 16:19             ` Junio C Hamano
2020-08-21 16:28               ` Jacob Keller
2020-08-21 17:16         ` Jacob Keller
2020-08-21 17:26           ` Jacob Keller
2020-08-21 18:21             ` Jacob Keller
2020-08-21 18:59               ` Jeff King
2020-08-17 16:18 ` Junio C Hamano [this message]
2020-08-21 21:17   ` [RFC 1/3] refspec: fix documentation referring to refspec_item Jacob Keller
2020-08-21 21:41     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqk0xx455u.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jacob.e.keller@intel.com \
    --cc=jacob.keller@gmail.com \
    --cc=peff@peff.net \
    --subject='Re: [RFC 1/3] refspec: fix documentation referring to refspec_item' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).