sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r1049394 - in /websites/staging/sis/trunk/content: ./ source.html
Date Thu, 29 Aug 2019 22:11:31 GMT
Author: buildbot
Date: Thu Aug 29 22:11:30 2019
New Revision: 1049394

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/source.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Aug 29 22:11:30 2019
@@ -1 +1 @@
-1866081
+1866105

Modified: websites/staging/sis/trunk/content/source.html
==============================================================================
--- websites/staging/sis/trunk/content/source.html (original)
+++ websites/staging/sis/trunk/content/source.html Thu Aug 29 22:11:30 2019
@@ -100,11 +100,11 @@
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <p>Apache SIS source code is maintained using <a href="http://git-scm.com">Git</a>
version control,
 completed by optional data maintained using <a href="http://subversion.apache.org">Subversion</a>
version control.
-Optional data include in particular the <a href="epsg.html">EPSG geodetic dataset</a>
-and are subject to different licensing terms.
+Optional data include in particular the <a href="epsg.html">EPSG geodetic dataset</a>,
+which is subject to licensing terms different than Apache ones.
 This page describes two ways to checkout Apache SIS source code:</p>
 <ul>
-<li>A basic checkout with only the main repository, the most stable branch, and no
configuration required.</li>
+<li>A basic checkout with only the main repository, the most stable branch, and no
configuration requirement.</li>
 <li>A more advanced configuration for active SIS developments, using uncommitted (for
now) API
     and including optional data for more extensive tests.</li>
 </ul>
@@ -117,7 +117,7 @@ or to cherry-pick only the interesting p
 <li><a href="#data">Create data directory</a></li>
 <li><a href="#non-free">Checkout non-free data</a></li>
 <li><a href="#postgres">Configure PostgreSQL</a></li>
-<li><a href="#geoapi-4.0">Switch to GeoAPI 4.0 branch</a></li>
+<li><a href="#branches">Switch to development branch</a></li>
 </ul>
 </li>
 <li><a href="#history">History</a></li>
@@ -132,28 +132,39 @@ or to cherry-pick only the interesting p
 <p>Create an empty directory for the Apache SIS project.
 We use <code>ApacheSIS</code> directory name in this page, but that name can
be anything;
 replace that name in the shell commands below if another name is used.
-The Apache SIS source code will be cloned in that directory:</p>
+The Apache SIS source code can be cloned in that directory as below
+(lines starting with <code>#</code> are comments and can be ignored):</p>
 <div class="codehilite"><pre>mkdir ApacheSIS
 <span class="nb">cd </span>ApacheSIS
 git clone https://gitbox.apache.org/repos/asf/sis
+<span class="c"># Alternatively, GitHub mirror can also be used:</span>
+<span class="c"># git clone https://github.com/apache/sis</span>
 </pre></div>
 
 
-<p>(note: <a href="https://github.com/apache/sis">GitHub URL</a> can be
substituted to above Apache GitBox URL if desired.)</p>
-<p>At this stage, the <code>ApacheSIS</code> directory is redundant with
the <code>sis</code> subdirectory.
-But we recommend to create that parent directory anyway in anticipation
-for more subdirectories to be created later, when desired.</p>
 <p>That is all. Apache SIS can be built by running <code>mvn install</code>
in the <code>sis</code> subdirectory.
-The remaining of this page describes optional configurations for more advanced developments.</p>
+At this stage, the <code>ApacheSIS</code> parent directory is redundant with
the <code>sis</code> subdirectory,
+but we recommend to create that parent directory anyway in anticipation
+for more subdirectories to be created later, when desired.
+The remaining of this page describes those optional configurations for more advanced developments.</p>
 <h1 id="advanced">Advanced installation<a class="headerlink" href="#advanced" title="Permanent
link">&para;</a></h1>
-<p>All sub-sections below are optional.</p>
+<p>This section assumes that above-described basic checkout has been done.
+All subsections below are optional. It is not mandatory to execute all of them,
+but we recommend to at least create the data directory described below
+because some other optional services depend on it.</p>
 <h2 id="data">Create data directory<a class="headerlink" href="#data" title="Permanent
link">&para;</a></h2>
 <p>Apache SIS needs a directory where to store database, datum shift files and other
optional data.
 That directory is specified by the <code>SIS_DATA</code> environment variable
and can be located anywhere.
-A convenient location is in a subdirectory of the <code>ApacheSIS</code> directory
created in above section.
+A convenient location is a subdirectory of the <code>ApacheSIS</code> directory
created in the "basic checkout" section.
 For example (with <code>ApacheSIS</code> as the current directory):</p>
 <div class="codehilite"><pre>mkdir Data
 <span class="nb">export </span><span class="nv">SIS_DATA</span><span
class="o">=</span><span class="nv">$PWD</span>/Data
+<span class="c">#</span>
+<span class="c"># For making that environment variable available in future shell sessions,</span>
+<span class="c"># the output of following command can be added to .bash_profile or
.bashrc</span>
+<span class="c"># file in user home directory.</span>
+<span class="c">#</span>
+<span class="nb">echo export </span><span class="nv">SIS_DATA</span><span
class="o">=</span><span class="nv">$SIS_DATA</span>
 </pre></div>
 
 
@@ -187,39 +198,44 @@ ln -s ../../../non-free/sis-epsg/src/mai
 without the need for <code>sis-epsg</code> or <code>sis-embedded-data</code>
module on the classpath.
 This setting is not done automatically because Apache projects can not introduce
 non-free dependencies without explicit action from user.
-If this action is not taken, some JUnit tests requiring EPSG data may be ignored
-(they will not cause the build to fail however).
-If any EPSG file is updated, deleting the <code>$SIS_DATA/Databases/SpatialMetadata</code>
directory
+If this action is not taken, some JUnit tests requiring EPSG data may be skipped.
+If any EPSG file is updated, deleting the <code>$SIS_DATA/​Databases/​SpatialMetadata</code>
directory
 is sufficient for causing Apache SIS to recreate the Derby database with new data.</p>
 <h2 id="postgres">Configure PostgreSQL<a class="headerlink" href="#postgres" title="Permanent
link">&para;</a></h2>
-<h2 id="geoapi-4.0">Switch to GeoAPI 4.0 branch<a class="headerlink" href="#geoapi-4.0"
title="Permanent link">&para;</a></h2>
-<p>The source code repository contains <code>geoapi-3.1</code> and <code>geoapi-4.0</code>
branches in addition of <code>master</code>.
-Apache SIS releases are created from code on <code>master</code> only, which
depends on GeoAPI 3.0.1
-(the <a href="http://www.geoapi.org/3.0/index.html">latest GeoAPI release</a>
from Open Geospatial Consortium).
-However the actual development occurs on the <code>geoapi-4.0</code> branch before
to be merged to <code>master</code>.
+<p>Apache SIS is tested with Derby, HSQL and PostgreSQL databases.
+Derby and HSQL are tested automatically using temporary databases in memory.
+But testing on PostgreSQL requires the creation of a dedicated database on the developer
platform.
+The requirements are:</p>
+<ul>
+<li>PostgreSQL server is running and listening to <code>localhost</code>
on default port (5432).</li>
+<li>An empty database named <code>"SpatialMetadataTest"</code> exists (Apache
SIS will not create it itself).</li>
+<li>A role having the same name than Unix user name exists</li>
+<li>Above-cited role can connect to <code>"SpatialMetadataTest"</code>
without password.</li>
+</ul>
+<p>The last point may require the following line in the <code>pg_hba.conf</code>
file
+(location of this file is system-dependent; try <code>/var/​lib/​pgsql/​data</code>):</p>
+<div class="codehilite"><pre>host    all    my_unix_user_name    127.0.0.1/32
   trust
+</pre></div>
+
+
+<h2 id="branches">Switch to development branch<a class="headerlink" href="#branches"
title="Permanent link">&para;</a></h2>
+<p>The source code repository contains <code>master</code>, <code>geoapi-3.1</code>
and <code>geoapi-4.0</code> branches.
+Apache SIS releases are created from <code>master</code>, which depends on the
latest GeoAPI version
+released by the Open Geospatial Consortium (<abbr title="Open Geospatial Consortium">OGC</abbr>),
currently <a href="http://www.geoapi.org/3.0/index.html">GeoAPI 3.0.1</a>.
+However daily developments occur on the <code>geoapi-4.0</code> branch before
to be merged (indirectly) to <code>master</code>.
 Those branches exist in order to experiment early new API and technologies — since it
may impact
-the library design — while keeping the releases compatible with officially released
environments.</p>
+the library design — while keeping the releases compatible with officially released
environments.
+In summary:</p>
 <ul>
-<li>
-<p>The <code>geoapi-4.0</code> branch implements interfaces defined in
GeoAPI 4.0 snapshot milestones.
-    Some changes in GeoAPI 4.0-SNAPSHOT interfaces are incompatible with GeoAPI 3.0.1 interfaces.
-    They are caused by changes in the underlying international standards, or by evolution
of Java technology.</p>
-</li>
-<li>
-<p>The <code>geoapi-3.1</code> branch implements interfaces defined in
<a href="http://www.geoapi.org/snapshot/index.html">GeoAPI 3.1 snapshot</a> milestones.
-    It has the same content that the <code>geoapi-4.0</code> branch, excluding
changes that are incompatible with GeoAPI 3.0.1.
-    This branch is used merely as an intermediate step between the development branch (<code>geoapi-4.0</code>)
and <code>master</code>.</p>
-</li>
-<li>
-<p>The <code>master</code> branch is a merge of <code>geoapi-3.1</code>
branch ported to the interfaces defined by the <a href="http://www.geoapi.org/3.0/index.html">GeoAPI
stable release</a>.
-    This is the code which is built by the continuous integration system and deployed on
the Maven repository.
-    <strong>Commits on master can not be removed, since <code>git push --force</code>
are not allowed on this branch.</strong>
-    Commits should be pushed on above-cited development branch first,
-    so they can be rearranged if needed before merge to <code>master</code>.</p>
-</li>
+<li>The <code>geoapi-4.0</code> branch implements interfaces defined in
GeoAPI 4.0 snapshots.</li>
+<li>The <code>geoapi-3.1</code> branch implements interfaces defined in
<a href="http://www.geoapi.org/snapshot/index.html">GeoAPI 3.1 snapshots</a>.</li>
+<li>The <code>master</code> implements interfaces defined by the <a
href="http://www.geoapi.org/3.0/index.html">GeoAPI 3.0.1 stable release</a>.</li>
 </ul>
-<p>The <code>geoapi</code> branches will hopefully be fully merged to <code>master</code>
in the future, depending on new GeoAPI releases from <abbr title="Open Geospatial Consortium">OGC</abbr>.
-In the meantime, developer can switch to the most active development branch as below:</p>
+<p>Developments on <code>geoapi-4.0</code> branch are merged to <code>geoapi-3.1</code>
branch, which is then merged to <code>master</code>.
+Note that commits on master can not be removed, since <code>git push --force</code>
is not allowed on that branch.
+If some commits need to be rearranged, it should be done on other branches before merge to
<code>master</code>.</p>
+<p>Developers can switch to the current development branch as below.
+Note that those <code>geoapi-xxx</code> branches may disappear after <abbr
title="Open Geospatial Consortium">OGC</abbr> released the corresponding GeoAPI versions.</p>
 <div class="codehilite"><pre><span class="nb">cd </span>sis
 git checkout geoapi-4.0
 </pre></div>



Mime
View raw message