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>
Michael Haggerty committed
Oct 23, 2013 at 17:50 UTC
5b2515f4007ce0fe3d61197905c41eee5a3d06c1
1 file changed
+10
-10
Documentation/technical/api-remote.txt
+10
-10
@@ -58,16 +58,16 @@ default remote, given the current branch and configuration.
58
struct refspec
59
--------------
60
61
-A struct refspec holds the parsed interpretation of a refspec. If it
62
-will force updates (starts with a '+'), force is true. If it is a
63
-pattern (sides end with '*') pattern is true. src and dest are the two
64
-sides (if a pattern, only the part outside of the wildcards); if there
65
-is only one side, it is src, and dst is NULL; if sides exist but are
66
-empty (i.e., the refspec either starts or ends with ':'), the
67
-corresponding side is "".
68
-
69
-This parsing can be done to an array of strings to give an array of
70
-struct refpsecs with parse_ref_spec().
61
+A struct refspec holds the parsed interpretation of a refspec. If it
62
+will force updates (starts with a '+'), force is true. If it is a
63
+pattern (sides end with '*') pattern is true. src and dest are the
64
+two sides (including '*' characters if present); if there is only one
65
+side, it is src, and dst is NULL; if sides exist but are empty (i.e.,
66
+the refspec either starts or ends with ':'), the corresponding side is
67
+"".
68
+
69
+An array of strings can be parsed into an array of struct refspecs
70
+using parse_fetch_refspec() or parse_push_refspec().
71
72
remote_find_tracking(), given a remote and a struct refspec with
73
either src or dst filled out, will fill out the other such that the