api-remote.txt: correct section "struct refspec"

* Replace reference to function parse_ref_spec() with references to
  functions parse_fetch_refspec() and parse_push_refspec().

* Correct description of src and dst: they *do* include the '*'
  characters.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael Haggerty 2013-10-23 17:50:37 +02:00 коммит произвёл Junio C Hamano
Родитель 68a304d5fe
Коммит 5b2515f400
1 изменённых файлов: 9 добавлений и 9 удалений

Просмотреть файл

@ -58,16 +58,16 @@ default remote, given the current branch and configuration.
struct refspec struct refspec
-------------- --------------
A struct refspec holds the parsed interpretation of a refspec. If it 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 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 pattern (sides end with '*') pattern is true. src and dest are the
sides (if a pattern, only the part outside of the wildcards); if there two sides (including '*' characters if present); if there is only one
is only one side, it is src, and dst is NULL; if sides exist but are side, it is src, and dst is NULL; if sides exist but are empty (i.e.,
empty (i.e., the refspec either starts or ends with ':'), the the refspec either starts or ends with ':'), the corresponding side is
corresponding side is "". "".
This parsing can be done to an array of strings to give an array of An array of strings can be parsed into an array of struct refspecs
struct refpsecs with parse_ref_spec(). using parse_fetch_refspec() or parse_push_refspec().
remote_find_tracking(), given a remote and a struct refspec with 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 either src or dst filled out, will fill out the other such that the