From 0becfec5b154c37a0cd2d3f7a6a0c908ba7b5c1e Mon Sep 17 00:00:00 2001 From: Jacob Keller Date: Fri, 14 Aug 2020 17:25:07 -0700 Subject: [PATCH 1/2] refspec: fix documentation referring to refspec_item 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. Signed-off-by: Jacob Keller Signed-off-by: Junio C Hamano --- refspec.h | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/refspec.h b/refspec.h index 23e1555b88..8d654e3a3a 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; From 95e7c385393488cb20c29697d8655f94ce83c413 Mon Sep 17 00:00:00 2001 From: Jacob Keller Date: Fri, 14 Aug 2020 17:25:08 -0700 Subject: [PATCH 2/2] refspec: make sure stack refspec_item variables are zeroed A couple of functions that used struct refspec_item did not zero out the structure memory. This can result in unexpected behavior, especially if additional parameters are ever added to refspec_item in the future. Use memset to ensure that unset structure members are zero. It may make sense to convert most of these uses of struct refspec_item to use either struct initializers or refspec_item_init_or_die. However, other similar code uses memset. Converting all of these uses has been left as a future exercise. Signed-off-by: Jacob Keller Signed-off-by: Junio C Hamano --- builtin/remote.c | 1 + transport.c | 1 + 2 files changed, 2 insertions(+) diff --git a/builtin/remote.c b/builtin/remote.c index c8240e9fcd..542f56e387 100644 --- a/builtin/remote.c +++ b/builtin/remote.c @@ -478,6 +478,7 @@ static int get_head_names(const struct ref *remote_refs, struct ref_states *stat struct ref *fetch_map = NULL, **fetch_map_tail = &fetch_map; struct refspec_item refspec; + memset(&refspec, 0, sizeof(refspec)); refspec.force = 0; refspec.pattern = 1; refspec.src = refspec.dst = "refs/heads/*"; diff --git a/transport.c b/transport.c index 2d4fd851dc..419be0b6ea 100644 --- a/transport.c +++ b/transport.c @@ -443,6 +443,7 @@ void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int v if (ref->status != REF_STATUS_OK && ref->status != REF_STATUS_UPTODATE) return; + memset(&rs, 0, sizeof(rs)); rs.src = ref->name; rs.dst = NULL;