From: Sandro Santilli <strk@keybit.net>
Date: Mon, 11 May 2015 17:07:38 +0000 (+0000)
Subject: Deprecate ST_Point_Inside_Circle (#2748)
X-Git-Tag: 2.2.0rc1~518
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a01a751914d16c46d5df12a7c72e2d65ad50d49c;p=postgis

Deprecate ST_Point_Inside_Circle (#2748)

git-svn-id: http://svn.osgeo.org/postgis/trunk@13488 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/doc/reference_misc.xml b/doc/reference_misc.xml
index d7beef8be..b7508430a 100644
--- a/doc/reference_misc.xml
+++ b/doc/reference_misc.xml
@@ -604,7 +604,7 @@ fulltable_size geomsize  pergeom
 
 	<refentry id="ST_Point_Inside_Circle">
 	  <refnamediv>
-		<refname>ST_Point_Inside_Circle</refname>
+		<refname>ST_PointInsideCircle</refname>
 
 		<refpurpose>Is the point geometry insert circle defined by center_x, center_y, radius</refpurpose>
 	  </refnamediv>
@@ -612,7 +612,7 @@ fulltable_size geomsize  pergeom
 	  <refsynopsisdiv>
 		<funcsynopsis>
 		  <funcprototype>
-			<funcdef>boolean <function>ST_Point_Inside_Circle</function></funcdef>
+			<funcdef>boolean <function>ST_PointInsideCircle</function></funcdef>
 			<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
 			<paramdef><type>float </type> <parameter>center_x</parameter></paramdef>
 			<paramdef><type>float </type> <parameter>center_y</parameter></paramdef>
@@ -625,18 +625,21 @@ fulltable_size geomsize  pergeom
 		<title>Description</title>
 
 		<para>The syntax for this functions is
-			point_inside_circle(&lt;geometry&gt;,&lt;circle_center_x&gt;,&lt;circle_center_y&gt;,&lt;radius&gt;).
+			ST_PointInsideCircle(&lt;geometry&gt;,&lt;circle_center_x&gt;,&lt;circle_center_y&gt;,&lt;radius&gt;).
 			Returns the true if the geometry is a point and is inside the
 			circle. Returns false otherwise.</para>
 		<note><para>This only works for points as the name suggests</para></note>
+
+		<para>Availability: 1.2</para>
+		<para>Changed: 2.2.0 In prior versions this used to be called ST_Point_Inside_Circle</para>
 	  </refsection>
 
 
 	  <refsection>
 		<title>Examples</title>
 
-		<programlisting>SELECT ST_Point_Inside_Circle(ST_Point(1,2), 0.5, 2, 3);
- st_point_inside_circle
+		<programlisting>SELECT ST_PointInsideCircle(ST_Point(1,2), 0.5, 2, 3);
+ st_pointinsidecircle
 ------------------------
  t
 </programlisting>
diff --git a/postgis/postgis.sql.in b/postgis/postgis.sql.in
index aee062c34..369640703 100644
--- a/postgis/postgis.sql.in
+++ b/postgis/postgis.sql.in
@@ -1294,12 +1294,21 @@ CREATE OR REPLACE FUNCTION ST_Distance(geom1 geometry, geom2 geometry)
 	LANGUAGE 'c' IMMUTABLE STRICT
 	COST 100;
 
--- Availability: 1.2.2
-CREATE OR REPLACE FUNCTION ST_point_inside_circle(geometry,float8,float8,float8)
+-- Availability: 2.2.0
+CREATE OR REPLACE FUNCTION ST_PointInsideCircle(geometry,float8,float8,float8)
 	RETURNS bool
 	AS 'MODULE_PATHNAME', 'LWGEOM_inside_circle_point'
 	LANGUAGE 'c' IMMUTABLE STRICT;
 
+-- Availability: 1.2.2
+-- Deprecation in 2.2.0
+CREATE OR REPLACE FUNCTION ST_point_inside_circle(geometry,float8,float8,float8)
+	RETURNS bool AS
+  $$ SELECT _postgis_deprecate('ST_Point_Inside_Circle', 'ST_PointInsideCircle', '2.2.0');
+    SELECT ST_PointInsideCircle($1,$2,$3,$4);
+  $$
+	LANGUAGE 'sql' IMMUTABLE STRICT;
+
 -- Availability: 1.2.2
 CREATE OR REPLACE FUNCTION ST_azimuth(geom1 geometry, geom2 geometry)
 	RETURNS float8