improve comments and declarations in rangeset.c

funbringer · funbringer · commit 4012acffe7dc · 2016-10-29T16:30:41.000+03:00
diff --git a/src/rangeset.c b/src/rangeset.c
@@ -11,6 +11,15 @@
 #include "rangeset.h"
 
 
+static IndexRange irange_handle_cover_internal(IndexRange ir_covering,
+											   IndexRange ir_inner,
+											   List **new_iranges);
+
+static IndexRange irange_union_internal(IndexRange first,
+										IndexRange second,
+										List **new_iranges);
+
+
 /* Check if two ranges intersect */
 bool
 iranges_intersect(IndexRange a, IndexRange b)
@@ -175,13 +184,13 @@ irange_union_internal(IndexRange first,
 		/* range 'first' covers 'second' */
 		if (irange_eq_bounds(ir_union, first))
 		{
-			/* Save rightmost IndexRange to 'ret' */
+			/* Return rightmost IndexRange, save others to 'new_iranges' */
 			return irange_handle_cover_internal(first, second, new_iranges);
 		}
 		/* range 'second' covers 'first' */
 		else if (irange_eq_bounds(ir_union, second))
 		{
-			/* Save rightmost IndexRange to 'ret' */
+			/* Retun rightmost IndexRange, save others to 'new_iranges' */
 			return irange_handle_cover_internal(second, first, new_iranges);
 		}
 		/* No obvious leader, lossiness differs */
@@ -242,9 +251,7 @@ irange_union_internal(IndexRange first,
 	}
 }
 
-/*
- * Make union of two index rage lists.
- */
+/* Make union of two index rage lists */
 List *
 irange_list_union(List *a, List *b)
 {
@@ -307,9 +314,7 @@ irange_list_union(List *a, List *b)
 	return result;
 }
 
-/*
- * Find intersection of two range lists.
- */
+/* Find intersection of two range lists */
 List *
 irange_list_intersection(List *a, List *b)
 {
diff --git a/src/rangeset.h b/src/rangeset.h
@@ -20,10 +20,10 @@
  * IndexRange contains a set of selected partitions.
  */
 typedef struct {
-	/* lossy == should we use IndexScan? */
+	/* lossy == should we use quals? */
 	/* valid == is this IndexRange valid? */
 
-	/* Don't swap this fields */
+	/* Don't swap these fields */
 	uint32	lower;	/* valid + lower_bound */
 	uint32	upper;	/* lossy + upper_bound */
 } IndexRange;

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,15 @@`
`11`	`11`	`#include "rangeset.h"`
`12`	`12`
`13`	`13`
	`14`	`+static IndexRange irange_handle_cover_internal(IndexRange ir_covering,`
	`15`	`+ IndexRange ir_inner,`
	`16`	`+ List **new_iranges);`
	`17`	`+`
	`18`	`+static IndexRange irange_union_internal(IndexRange first,`
	`19`	`+ IndexRange second,`
	`20`	`+ List **new_iranges);`
	`21`	`+`
	`22`	`+`
`14`	`23`	`/* Check if two ranges intersect */`
`15`	`24`	`bool`
`16`	`25`	`iranges_intersect(IndexRange a, IndexRange b)`
`@@ -175,13 +184,13 @@ irange_union_internal(IndexRange first,`
`175`	`184`	`/* range 'first' covers 'second' */`
`176`	`185`	`if (irange_eq_bounds(ir_union, first))`
`177`	`186`	`{`
`178`		`- /* Save rightmost IndexRange to 'ret' */`
	`187`	`+ /* Return rightmost IndexRange, save others to 'new_iranges' */`
`179`	`188`	`return irange_handle_cover_internal(first, second, new_iranges);`
`180`	`189`	`}`
`181`	`190`	`/* range 'second' covers 'first' */`
`182`	`191`	`else if (irange_eq_bounds(ir_union, second))`
`183`	`192`	`{`
`184`		`- /* Save rightmost IndexRange to 'ret' */`
	`193`	`+ /* Retun rightmost IndexRange, save others to 'new_iranges' */`
`185`	`194`	`return irange_handle_cover_internal(second, first, new_iranges);`
`186`	`195`	`}`
`187`	`196`	`/* No obvious leader, lossiness differs */`
`@@ -242,9 +251,7 @@ irange_union_internal(IndexRange first,`
`242`	`251`	`}`
`243`	`252`	`}`
`244`	`253`
`245`		`-/*`
`246`		`- * Make union of two index rage lists.`
`247`		`- */`
	`254`	`+/* Make union of two index rage lists */`
`248`	`255`	`List *`
`249`	`256`	`irange_list_union(List a, List b)`
`250`	`257`	`{`
`@@ -307,9 +314,7 @@ irange_list_union(List a, List b)`
`307`	`314`	`return result;`
`308`	`315`	`}`
`309`	`316`
`310`		`-/*`
`311`		`- * Find intersection of two range lists.`
`312`		`- */`
	`317`	`+/* Find intersection of two range lists */`
`313`	`318`	`List *`
`314`	`319`	`irange_list_intersection(List a, List b)`
`315`	`320`	`{`