Fix header comment for bitncmp().

tglsfdc · tglsfdc · commit 5858cf8ab2c7 · 2014-01-04T14:01:51.000-05:00
The result is an int less than, equal to, or greater than zero, in the
style of memcmp (and, in fact, exactly the output of memcmp in some cases).
This comment previously said -1, 1, or 0, which was an overspecification,
as noted by Emre Hasegeli.  All of the existing callers appear to be fine
with the actual behavior, so just fix the comment.

In passing, improve infelicitous formatting of some call sites.
diff --git a/src/backend/utils/adt/network.c b/src/backend/utils/adt/network.c
@@ -544,8 +544,8 @@ network_sub(PG_FUNCTION_ARGS)
 
 	if (ip_family(a1) == ip_family(a2))
 	{
-		PG_RETURN_BOOL(ip_bits(a1) > ip_bits(a2)
-					 && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);
+		PG_RETURN_BOOL(ip_bits(a1) > ip_bits(a2) &&
+					   bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);
 	}
 
 	PG_RETURN_BOOL(false);
@@ -559,8 +559,8 @@ network_subeq(PG_FUNCTION_ARGS)
 
 	if (ip_family(a1) == ip_family(a2))
 	{
-		PG_RETURN_BOOL(ip_bits(a1) >= ip_bits(a2)
-					 && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);
+		PG_RETURN_BOOL(ip_bits(a1) >= ip_bits(a2) &&
+					   bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);
 	}
 
 	PG_RETURN_BOOL(false);
@@ -574,8 +574,8 @@ network_sup(PG_FUNCTION_ARGS)
 
 	if (ip_family(a1) == ip_family(a2))
 	{
-		PG_RETURN_BOOL(ip_bits(a1) < ip_bits(a2)
-					 && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);
+		PG_RETURN_BOOL(ip_bits(a1) < ip_bits(a2) &&
+					   bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);
 	}
 
 	PG_RETURN_BOOL(false);
@@ -589,8 +589,8 @@ network_supeq(PG_FUNCTION_ARGS)
 
 	if (ip_family(a1) == ip_family(a2))
 	{
-		PG_RETURN_BOOL(ip_bits(a1) <= ip_bits(a2)
-					 && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);
+		PG_RETURN_BOOL(ip_bits(a1) <= ip_bits(a2) &&
+					   bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);
 	}
 
 	PG_RETURN_BOOL(false);
@@ -955,7 +955,7 @@ convert_network_to_scalar(Datum value, Oid typid)
  * bitncmp(l, r, n)
  *		compare bit masks l and r, for n bits.
  * return:
- *		-1, 1, or 0 in the libc tradition.
+ *		<0, >0, or 0 in the libc tradition.
  * note:
  *		network byte order assumed.  this means 192.5.5.240/28 has
  *		0x11110000 in its fourth octet.

Original file line number	Diff line number	Diff line change
`@@ -544,8 +544,8 @@ network_sub(PG_FUNCTION_ARGS)`
`544`	`544`
`545`	`545`	`if (ip_family(a1) == ip_family(a2))`
`546`	`546`	`{`
`547`		`- PG_RETURN_BOOL(ip_bits(a1) > ip_bits(a2)`
`548`		`- && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);`
	`547`	`+ PG_RETURN_BOOL(ip_bits(a1) > ip_bits(a2) &&`
	`548`	`+ bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);`
`549`	`549`	`}`
`550`	`550`
`551`	`551`	`PG_RETURN_BOOL(false);`
`@@ -559,8 +559,8 @@ network_subeq(PG_FUNCTION_ARGS)`
`559`	`559`
`560`	`560`	`if (ip_family(a1) == ip_family(a2))`
`561`	`561`	`{`
`562`		`- PG_RETURN_BOOL(ip_bits(a1) >= ip_bits(a2)`
`563`		`- && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);`
	`562`	`+ PG_RETURN_BOOL(ip_bits(a1) >= ip_bits(a2) &&`
	`563`	`+ bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a2)) == 0);`
`564`	`564`	`}`
`565`	`565`
`566`	`566`	`PG_RETURN_BOOL(false);`
`@@ -574,8 +574,8 @@ network_sup(PG_FUNCTION_ARGS)`
`574`	`574`
`575`	`575`	`if (ip_family(a1) == ip_family(a2))`
`576`	`576`	`{`
`577`		`- PG_RETURN_BOOL(ip_bits(a1) < ip_bits(a2)`
`578`		`- && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);`
	`577`	`+ PG_RETURN_BOOL(ip_bits(a1) < ip_bits(a2) &&`
	`578`	`+ bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);`
`579`	`579`	`}`
`580`	`580`
`581`	`581`	`PG_RETURN_BOOL(false);`
`@@ -589,8 +589,8 @@ network_supeq(PG_FUNCTION_ARGS)`
`589`	`589`
`590`	`590`	`if (ip_family(a1) == ip_family(a2))`
`591`	`591`	`{`
`592`		`- PG_RETURN_BOOL(ip_bits(a1) <= ip_bits(a2)`
`593`		`- && bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);`
	`592`	`+ PG_RETURN_BOOL(ip_bits(a1) <= ip_bits(a2) &&`
	`593`	`+ bitncmp(ip_addr(a1), ip_addr(a2), ip_bits(a1)) == 0);`
`594`	`594`	`}`
`595`	`595`
`596`	`596`	`PG_RETURN_BOOL(false);`
`@@ -955,7 +955,7 @@ convert_network_to_scalar(Datum value, Oid typid)`
`955`	`955`	`* bitncmp(l, r, n)`
`956`	`956`	`* compare bit masks l and r, for n bits.`
`957`	`957`	`* return:`
`958`		`- * -1, 1, or 0 in the libc tradition.`
	`958`	`+ * <0, >0, or 0 in the libc tradition.`
`959`	`959`	`* note:`
`960`	`960`	`* network byte order assumed. this means 192.5.5.240/28 has`
`961`	`961`	`* 0x11110000 in its fourth octet.`