From: Michael Haggerty <mhagger@alum.mit.edu>
To: Tom Grennan <tmgrennan@gmail.com>
Cc: pclouds@gmail.com, git@vger.kernel.org, gitster@pobox.com,
krh@redhat.com, jasampler@gmail.com
Subject: Re: [PATCHv2 1/4] refs: add common refname_match_patterns()
Date: Sat, 11 Feb 2012 08:12:54 +0100 [thread overview]
Message-ID: <4F3614F6.2000106@alum.mit.edu> (raw)
In-Reply-To: <1328926618-17167-2-git-send-email-tmgrennan@gmail.com>
On 02/11/2012 03:16 AM, Tom Grennan wrote:
> diff --git a/refs.h b/refs.h
> index 00ba1e2..13015ba 100644
> --- a/refs.h
> +++ b/refs.h
> @@ -152,4 +152,12 @@ int update_ref(const char *action, const char *refname,
> const unsigned char *sha1, const unsigned char *oldval,
> int flags, enum action_on_err onerr);
>
> +/**
> + * Returns:
> + * 1 with NULL patterns
> + * 0 if refname fnmatch()es any ! prefaced pattern
> + * 1 if refname fnmatch()es any pattern
> + */
> +extern int refname_match_patterns(const char **patterns, const char *refname);
> +
> #endif /* REFS_H */
This comment is unclear and incomplete.
1. What does "NULL patterns" mean? Your code fails if patterns==NULL,
so I guess you mean "1 if there are no patterns in the list".
2. Since the three conditions are not mutually exclusive, you should say
how they are connected. I believe that you want something like "A
otherwise B otherwise C".
3. You haven't specified what happens if refname matches neither a
!-prefixed pattern nor a non-!-prefixed pattern. Does this behavior
depend on which types of patterns were present in the list?
I see that you have described the behavior more completely in the commit
message for patch 2/4, but the commit message is not enough: this
behavior should be described precisely in both code comments (when the
function is defined) and in the user documentation (when the
functionality is added to a command).
Michael
--
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
next prev parent reply other threads:[~2012-02-11 7:13 UTC|newest]
Thread overview: 83+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-02-09 19:43 [RFC/PATCH] tag: make list exclude !<pattern> Tom Grennan
2012-02-09 19:43 ` Tom Grennan
2012-02-10 0:00 ` Tom Grennan
2012-02-10 6:34 ` Nguyen Thai Ngoc Duy
2012-02-10 18:55 ` Tom Grennan
2012-02-11 2:16 ` Tom Grennan
2012-02-11 3:06 ` Junio C Hamano
2012-02-11 7:50 ` Junio C Hamano
2012-02-11 10:13 ` Jakub Narebski
2012-02-11 14:06 ` Nguyen Thai Ngoc Duy
2012-02-11 18:31 ` Junio C Hamano
2012-02-11 19:47 ` Tom Grennan
2012-02-11 7:50 ` Michael Haggerty
2012-02-11 8:13 ` Junio C Hamano
2012-02-13 5:29 ` Michael Haggerty
2012-02-13 6:37 ` Junio C Hamano
2012-02-13 9:37 ` Michael Haggerty
2012-02-13 10:23 ` Junio C Hamano
2012-02-13 14:34 ` Michael Haggerty
2012-02-13 20:29 ` Junio C Hamano
2012-02-11 19:08 ` Tom Grennan
2012-02-22 1:28 ` [PATCHv3 0/5] " Tom Grennan
2012-02-22 1:28 ` [PATCHv3 1/5] refs: add match_pattern() Tom Grennan
2012-02-22 6:33 ` Junio C Hamano
2012-02-22 23:47 ` Tom Grennan
2012-02-23 0:17 ` Junio C Hamano
2012-02-23 0:59 ` Tom Grennan
2012-02-22 1:28 ` [PATCHv3 2/5] tag --points-at option wrapper Tom Grennan
2012-02-22 1:28 ` [PATCHv3 3/5] tag --exclude option Tom Grennan
2012-02-22 6:33 ` Junio C Hamano
2012-02-23 0:22 ` Tom Grennan
2012-02-23 1:00 ` Junio C Hamano
2012-03-01 1:45 ` [PATCH 0/5] modernize test style Tom Grennan
2012-03-03 2:15 ` [PATCHv2 " Tom Grennan
2012-03-03 8:04 ` Junio C Hamano
2012-03-03 17:42 ` Tom Grennan
2012-03-03 2:15 ` [PATCHv2 1/5] t7004 (tag): modernize style Tom Grennan
2012-03-03 21:31 ` Johannes Sixt
2012-03-03 2:15 ` [PATCHv2 2/5] t5512 (ls-remote): " Tom Grennan
2012-03-03 8:05 ` Junio C Hamano
2012-03-03 17:33 ` Tom Grennan
2012-03-03 2:15 ` [PATCHv2 3/5] t3200 (branch): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2 4/5] t0040 (parse-options): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2 5/5] t6300 (for-each-ref): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2-w 101/105] t7004 (tag): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2-w 102/105] t5512 (ls-remote): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2-w 103/105] t3200 (branch): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2-w 104/105] t0040 (parse-options): " Tom Grennan
2012-03-03 2:15 ` [PATCHv2-w 105/105] t6300 (for-each-ref): " Tom Grennan
2012-03-01 1:45 ` [PATCH 1/5] " Tom Grennan
2012-03-01 6:53 ` Johannes Sixt
2012-03-01 15:58 ` Tom Grennan
2012-03-01 1:45 ` [PATCH 2/5] t5512 (ls-remote): " Tom Grennan
2012-03-01 8:36 ` Thomas Rast
2012-03-01 1:45 ` [PATCH 3/5] t3200 (branch): " Tom Grennan
2012-03-01 1:45 ` [PATCH 4/5] t0040 (parse-options): " Tom Grennan
2012-03-01 1:45 ` [PATCH 5/5] t7004 (tag): " Tom Grennan
2012-03-01 1:45 ` [PATCH-w 101/105] t6300 (for-each-ref): " Tom Grennan
2012-03-01 2:13 ` Junio C Hamano
2012-03-01 3:20 ` Tom Grennan
2012-03-01 3:26 ` Junio C Hamano
2012-03-01 5:10 ` Tom Grennan
2012-03-01 5:57 ` Tom Grennan
2012-03-01 8:42 ` Thomas Rast
2012-03-01 15:48 ` Tom Grennan
2012-03-01 1:45 ` [PATCH-w 102/105] t5512 (ls-remote): " Tom Grennan
2012-03-01 1:45 ` [PATCH-w 103/105] t3200 (branch): " Tom Grennan
2012-03-01 1:45 ` [PATCH-w 104/105] t0040 (parse-options): " Tom Grennan
2012-03-01 1:45 ` [PATCH-w 105/105] t7004 (tag): " Tom Grennan
2012-02-22 1:28 ` [PATCHv3 4/5] branch --exclude option Tom Grennan
2012-02-22 1:28 ` [PATCHv3 5/5] for-each-ref " Tom Grennan
2012-02-11 2:16 ` [PATCHv2 1/4] refs: add common refname_match_patterns() Tom Grennan
2012-02-11 7:12 ` Michael Haggerty [this message]
2012-02-11 19:17 ` Tom Grennan
2012-02-13 5:00 ` Michael Haggerty
2012-02-13 17:27 ` Tom Grennan
2012-02-11 8:06 ` Junio C Hamano
2012-02-11 19:37 ` Tom Grennan
2012-02-11 23:43 ` Junio C Hamano
2012-02-13 16:29 ` Tom Grennan
2012-02-11 2:16 ` [PATCHv2 2/4] tag: use refs.c:refname_match_patterns() Tom Grennan
2012-02-11 2:16 ` [PATCHv2 3/4] branch: " Tom Grennan
2012-02-11 2:16 ` [PATCHv2 4/4] for-each-ref: " Tom Grennan
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4F3614F6.2000106@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jasampler@gmail.com \
--cc=krh@redhat.com \
--cc=pclouds@gmail.com \
--cc=tmgrennan@gmail.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).