Skip to content

Commit

Permalink
Elaborate review comments from @esabol
Browse files Browse the repository at this point in the history
  • Loading branch information
vitcpp committed Sep 26, 2023
1 parent d720dc6 commit 8a03ed4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/functions.sgm
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
</example>

<example>
<title>Area of a moc object</title>
<title>Area of a Multi-Order Coverage (MOC) object</title>
<programlisting>
<![CDATA[sql> SELECT area(smoc '0/1-3');]]>
<![CDATA[ area]]>
Expand Down
21 changes: 12 additions & 9 deletions doc/install.sgm
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

<para>
&pgsphere; is not the part of the &postgresql; software. You can download
the latest release sources from the
the latest release from the
<ulink url="&pgsphereurl;">&pgsphere; Releases page</ulink>.
The sources can also be downloaded by cloning the repository with the
The source code can also be downloaded by cloning the repository with the
appropriate release tag. The master branch is intended for development
use and may contain the code in a transitional state. It is not recommended
for use in production.
Expand All @@ -27,7 +27,9 @@
The installation script uses &pg_config; utility. Make sure that the
environment variable PATH includes path to &pg_config; utility. The path
to &pg_config; can be also specified in make command:
make&nbsp;PG_CONFIG=/path/to/pgconfig.
<programlisting>
<![CDATA[shell> make PG_CONFIG=/path/to/pgconfig ...]]>
</programlisting>
</para>

<para>Unpack the downloaded archive and enter the directory:</para>
Expand All @@ -37,20 +39,20 @@
</programlisting>

<para>
Compile the code. By default, &pgsphere; is compiled with the HEALPIX
Compile the code. By default, &pgsphere; is compiled with the &healpix;
support.
</para>
<programlisting>
<![CDATA[shell> make]]>
</programlisting>
<para>or compile without HEALPIX support:</para>
<para>or compile without &healpix; support:</para>
<programlisting>
<![CDATA[shell> make USE_HEALPIX=0]]>
</programlisting>

<para>
Run regression tests optionally. If the &pgsphere; was compiled without
HEALPIX support, USE_HEALPIX=0 should be specified in make command line.
Run regression tests optionally. If &pgsphere; was compiled without &healpix;
support, USE_HEALPIX=0 should be specified in make command line.
</para>
<programlisting>
<![CDATA[shell> make test]]>
Expand All @@ -59,7 +61,8 @@
<para>
Install &pgsphere; files to the installation directories. The installation
directories are defined by &pg_config; utility. Superuser (root) access
rights may be required.
rights may be required. If &pgsphere; was compiled without &healpix; support,
USE_HEALPIX=0 should be added after make.
</para>
<programlisting>
<![CDATA[shell> make install]]>
Expand Down Expand Up @@ -89,7 +92,7 @@
</ulink>.
</para>

<para>To get the version of installed pgSphere software:</para>
<para>To get the version of installed &pgsphere; software:</para>
<programlisting>
<![CDATA[pgsql> SELECT pg_sphere_version();]]>
</programlisting>
Expand Down
1 change: 1 addition & 0 deletions doc/pg_sphere.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
<!ENTITY pg_ohgr "<symbol role='symbol'>&ohgr;</symbol>">
<!ENTITY pg_OHgr "<symbol role='symbol'>&OHgr;</symbol>">
<!ENTITY pg_pgr "<symbol role='symbol'>&pgr;</symbol>">
<!ENTITY healpix "<application>HEALPix</application>">
<!ENTITY pgsphere "<application>pgSphere</application>">
<!ENTITY postgresql "<application>PostgreSQL</application>">
<!ENTITY pg_config "<application>pg_config</application>">
Expand Down

0 comments on commit 8a03ed4

Please sign in to comment.