[PATCH v2] line-log: clarify [a,b) notation for ranges
- From
Andrei Rybak <rybak.a.v@gmail.com>
- Date
- Aug 8, 2018, 16:26 UTC
- Message-ID
- <b80df985-03ef-ddb0-37aa-10fd411a1f11@gmail.com>
- In-Reply-To
- <be1dd423-f9de-a436-6127-02cce4ab1977@gmail.com>
line-log.[ch] use left-closed, right-open interval logic. Update comments and debug output to use square brackets+parentheses notation to help developers avoid off-by-one errors.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com> ---
Applies on top of c0babbe69 (range-set: publish API for re-use by git-blame -L, 2013-08-06). When applied on the original commit 12da1d1f6 (Implement line-history search (git log -L), 2013-03-28), the conflict is in removal of "static" from some functions.
Changes since v1:
- reword commit message a bit - sign-off - add [a,b) to comment of range_set_append_unsafe
I decided not to remove "_at the end_", as
/* tack on a _new_ range [a,b) */
seems a bit less readable to me.
line-log.c | 6 +++--- line-log.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/line-log.c b/line-log.c index fa9cfd5bd..9ab6d51cc 100644 --- a/line-log.c +++ b/line-log.c @@ -56,7 +56,7 @@ static void range_set_move(struct range_set *dst, struct range_set *src) src->alloc = src->nr = 0; } -/* tack on a _new_ range _at the end_ */ +/* tack on a _new_ range [a,b) _at the end_ */ void range_set_append_unsafe(struct range_set *rs, long a, long b) { assert(a <= b); @@ -353,7 +353,7 @@ static void dump_range_set(struct range_set *rs, const char *desc) int i; printf("range set %s (%d items):\n", desc, rs->nr); for (i = 0; i < rs->nr; i++) - printf("\t[%ld,%ld]\n", rs->ranges[i].start, rs->ranges[i].end); + printf("\t[%ld,%ld)\n", rs->ranges[i].start, rs->ranges[i].end); } static void dump_line_log_data(struct line_log_data *r) @@ -373,7 +373,7 @@ static void dump_diff_ranges(struct diff_ranges *diff, const char *desc) printf("diff ranges %s (%d items):\n", desc, diff->parent.nr); printf("\tparent\ttarget\n"); for (i = 0; i < diff->parent.nr; i++) { - printf("\t[%ld,%ld]\t[%ld,%ld]\n", + printf("\t[%ld,%ld)\t[%ld,%ld)\n", diff->parent.ranges[i].start, diff->parent.ranges[i].end, diff->target.ranges[i].start, diff --git a/line-log.h b/line-log.h index e2a5ee7c6..488c86409 100644 --- a/line-log.h +++ b/line-log.h @@ -6,7 +6,7 @@ struct rev_info; struct commit; -/* A range [start,end]. Lines are numbered starting at 0, and the +/* A range [start,end). Lines are numbered starting at 0, and the * ranges include start but exclude end. */ struct range { long start, end;
-- 2.18.0