Skip to content

Commit 4ea6803

Browse files
committed
Remove the obsolete text from the doc
1 parent 3a912fc commit 4ea6803

File tree

3 files changed

+30
-22
lines changed

3 files changed

+30
-22
lines changed

doc/functions.sgm

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414
<para>
1515
The <function>area</function> function returns the area of a
1616
spherical object in square radians. Supported data types are:
17-
<type>scircle</type>, <type>spolygon</type> (if the polygon
18-
is convex), <type>sbox</type>, and <type>smoc</type>.
17+
<type>scircle</type>, <type>spolygon</type>, <type>sbox</type>,
18+
<type>smoc</type>. The polygon should be convex, otherwise the
19+
behaviour is undefined.
1920
</para>
2021
<example>
2122
<title>Area of a spherical circle as a multiple of &pg_pgr;</title>
@@ -25,6 +26,12 @@
2526
<![CDATA[------]]>
2627
<![CDATA[ 1]]>
2728
<![CDATA[(1 row)]]>
29+
</programlisting>
30+
</example>
31+
32+
<example>
33+
<title>Area of a moc object</title>
34+
<programlisting>
2835
<![CDATA[sql> SELECT area(smoc '0/1-3');]]>
2936
<![CDATA[ area]]>
3037
<![CDATA[-------------------]]>

doc/install.sgm

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,15 @@
77
</title>
88
<para>
99
<application>pgSphere</application> is not part of the <application>PostgreSQL</application> software.
10-
You can download it from the <application>pgSphere</application> homepage
11-
<ulink url="https://github.com/postgrespro/pgsphere"><citetitle>https://github.com/postgrespro/pgsphere</citetitle></ulink>
10+
You can download the latest release sources from the
11+
<ulink url="https://github.com/postgrespro/pgsphere/releases">
12+
<application>pgSphere</application> homepage
13+
</ulink> (the Releases page). The sources can also be downloaded by
14+
cloning the repository with the appropriate release tag (each release is
15+
marked with a tag).
16+
The master branch is intended for development use
17+
and can contain an intermediate work.
18+
It is not recommented for use in production.
1219
</para>
1320
</sect1>
1421

@@ -17,8 +24,7 @@
1724
Installation
1825
</title>
1926
<para>
20-
You will need <application>PostgreSQL
21-
9.1</application> or above. We assume that you have
27+
We assume that you have
2228
<application>PostgreSQL</application> already compiled and
2329
installed. Please note: Depending on your system configuration mostly you have to be logged in as the system
2430
superuser.
@@ -32,10 +38,11 @@
3238
If the sources are not yet installed and the directory
3339
<filename>pg_sphere</filename> does not exist, take the
3440
gzipped <application>pgSphere</application> sources ( e. g.,
35-
<filename>pg_sphere_xxx.tgz</filename> ) and run:
41+
<filename>pgsphere-X.X.X.tgz</filename>, where X.X.X is the version number)
42+
and run:
3643
</para>
3744
<programlisting>
38-
<![CDATA[shell> tar -xzf path/to/pg_sphere_xxx.tgz]]>
45+
<![CDATA[shell> tar -xzf path/to/pgsphere-X.X.X.tgz]]>
3946
</programlisting>
4047
<para>
4148
Now, change into the <filename>pg_sphere</filename>
@@ -58,7 +65,7 @@
5865
First unpack the <application>pgSphere</application> sources:
5966
</para>
6067
<programlisting>
61-
<![CDATA[shell> tar -xzf path_to_pg_sphere_xxx.tgz]]>
68+
<![CDATA[shell> tar -xzf path/to/pgsphere-X.X.X.tgz]]>
6269
</programlisting>
6370
<para>
6471
Now, change into the <filename>pg_sphere</filename>
@@ -80,12 +87,6 @@
8087
<programlisting>
8188
<![CDATA[shell> make installcheck]]>
8289
</programlisting>
83-
<para>
84-
The check status will be displayed. Please note, the check gives different results with
85-
different <application>PostgreSQL</application>-versions. Currently, the check should
86-
run without errors with <application>PostgreSQL</application>-version 8.4. Otherwise check
87-
the file <filename>regression.diff</filename>.
88-
</para>
8990

9091
</sect1>
9192

@@ -105,11 +106,13 @@
105106
<![CDATA[shell> psql -U postgres -c 'CREATE EXTENSION pg_sphere' datab]]>
106107
</programlisting>
107108
<para>
108-
Depending on your system, it may be necessary to give more
109-
<command>psql</command> options like port or host name.
110-
Please have a look at the
111-
<application>PostgreSQL</application> documentation for more
112-
details.
109+
It may be necessary to give more
110+
<command>psql</command> options, like port or host name,
111+
depending on your system.
112+
Please take a look at the psql user manual for details.
113+
The psql user manual for the latest postgresql version can be
114+
found at <ulink url="https://www.postgresql.org/docs/current/app-psql.html">
115+
PostgreSQL site</ulink>.
113116
</para>
114117
<para>
115118
To get the version of installed pgSphere software, simply

doc/pg_sphere.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111
<!ENTITY capFunctions SYSTEM "functions.sgm">
1212
<!ENTITY capIndices SYSTEM "indices.sgm">
1313
<!ENTITY capExamples SYSTEM "examples.sgm">
14-
<!ENTITY capFaq SYSTEM "faq.sgm">
15-
<!ENTITY capAppendixes SYSTEM "appendixes.sgm">
1614

1715
<!ENTITY graph1001 "img/spoint.jpg">
1816
<!ENTITY graph1002 "img/scircle.jpg">

0 commit comments

Comments
 (0)