minor refspec cleanups
cover minor refspec cleanups
From: Jacob Keller <[email protected]>
While preparing some patches for implementing support for negative refspecs, I found a couple of minor nits. The first patch fixes the documentation in refspec.h to refer to the correct structures. The second patch cleans up a potential issue with refspec_item structures that weren't initialized properly. While nothing breaks today, future extensions to refspec_item would break if the structure wasn't properly initialized to zero.
Jacob Keller (2):
refspec: fix documentation referring to refspec_item
refspec: make sure stack refspec_item variables are zeroed
builtin/remote.c | 1 + refspec.h | 27 ++++++++++++++------------- transport.c | 1 + 3 files changed, 16 insertions(+), 13 deletions(-)
base-commit: 878e727637ec5815ccb3301eb994a54df95b21b8
Signature · 1 line
2.28.0.218.ge27853923b9d.dirty
PATCH 1/2 refspec: fix documentation referring to refspec_item
From: Jacob Keller <[email protected]>
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.
--- refspec.h | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)
refspec.h +14 -13
@@ -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;
Signature · 1 line
2.28.0.218.ge27853923b9d.dirty
PATCH 2/2 refspec: make sure stack refspec_item variables are zeroed
In reply to Jacob KellerFrom: Jacob Keller <[email protected]>
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.
--- builtin/remote.c | 1 + transport.c | 1 + 2 files changed, 2 insertions(+)
builtin/remote.c +1 -0
@@ -478,6 +478,7 @@ static int get_head_names(const struct ref *remote_refs, struct ref_states *statstruct 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/*" ;
transport.c +1 -0
@@ -443,6 +443,7 @@ void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int vif (ref->status !=REF_STATUS_OK && ref->status !=REF_STATUS_UPTODATE )return ; +memset (&rs,0 ,sizeof (rs)); rs.src = ref->name; rs.dst =NULL ;
Signature · 1 line
2.28.0.218.ge27853923b9d.dirty