polygene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nic...@apache.org
Subject polygene-java git commit: Fixing documentation errors found.
Date Sun, 16 Apr 2017 07:14:56 GMT
Repository: polygene-java
Updated Branches:
  refs/heads/develop deb467c98 -> eec1660fb


Fixing documentation errors found.

Signed-off-by: niclas <niclas@hedhman.org>


Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/eec1660f
Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/eec1660f
Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/eec1660f

Branch: refs/heads/develop
Commit: eec1660fb54aeaaece03aa4de2e3bd995c385af6
Parents: deb467c
Author: niclas <niclas@hedhman.org>
Authored: Sun Apr 16 15:14:29 2017 +0800
Committer: niclas <niclas@hedhman.org>
Committed: Sun Apr 16 15:14:29 2017 +0800

----------------------------------------------------------------------
 extensions/entitystore-sql/src/docs/es-sql.txt            |  2 +-
 .../src/docs/index-elasticsearch.txt                      |  2 +-
 libraries/scripting/src/docs/groovy.txt                   |  4 ++--
 libraries/scripting/src/docs/scripting.txt                |  2 +-
 .../library/sql/generator/vendor/SQLVendorProvider.java   | 10 +++++++++-
 manual/src/docs/userguide/tools.txt                       |  6 +++---
 manual/src/docs/website/intro.txt                         |  2 +-
 manual/src/docs/website/resources/css/style.css           |  2 +-
 tools/src/docs/yeoman_polygene.txt                        |  3 +--
 9 files changed, 20 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/extensions/entitystore-sql/src/docs/es-sql.txt
----------------------------------------------------------------------
diff --git a/extensions/entitystore-sql/src/docs/es-sql.txt b/extensions/entitystore-sql/src/docs/es-sql.txt
index 90a7175..e0328a1 100644
--- a/extensions/entitystore-sql/src/docs/es-sql.txt
+++ b/extensions/entitystore-sql/src/docs/es-sql.txt
@@ -55,7 +55,7 @@ Here are the available configuration properties:
 [snippet,java]
 ----
 source=extensions/entitystore-sql/src/main/java/org/apache/polygene/entitystore/sql/SQLMapEntityStoreConfiguration.java
-tag=assembly
+tag=config
 ----
 
 The assembly snippets below show the DataSource assembly alongside the SQL EntityStore assembly.
Remember to configure

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/extensions/indexing-elasticsearch/src/docs/index-elasticsearch.txt
----------------------------------------------------------------------
diff --git a/extensions/indexing-elasticsearch/src/docs/index-elasticsearch.txt b/extensions/indexing-elasticsearch/src/docs/index-elasticsearch.txt
index 42f0616..3bb1feb 100644
--- a/extensions/indexing-elasticsearch/src/docs/index-elasticsearch.txt
+++ b/extensions/indexing-elasticsearch/src/docs/index-elasticsearch.txt
@@ -122,7 +122,7 @@ Note that the `clusterName` is ignored as this is managed by the client.
 [snippet,java]
 ----
 source=extensions/indexing-elasticsearch/src/main/java/org/apache/polygene/index/elasticsearch/ElasticSearchConfiguration.java
-tag=client
+tag=config
 ----
 
 Again, all configuration properties are defaulted meaning that you can use ElasticSearch
Index/Query service without

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/libraries/scripting/src/docs/groovy.txt
----------------------------------------------------------------------
diff --git a/libraries/scripting/src/docs/groovy.txt b/libraries/scripting/src/docs/groovy.txt
index c60850c..a14dfe3 100644
--- a/libraries/scripting/src/docs/groovy.txt
+++ b/libraries/scripting/src/docs/groovy.txt
@@ -53,7 +53,7 @@ assemble it directly:
 
 [snippet,java]
 ----
-source=libraries/scripting/src/test/java/org/apache/polygene/library/scripting/HelloSpeakerTest.java
+source=libraries/scripting/src/test/groovy/org/apache/polygene/library/scripting/HelloSpeakerTest.java
 tag=direct
 ----
 
@@ -72,6 +72,6 @@ Then assemble it with the normal +ScriptMixin+:
 
 [snippet,java]
 ----
-source=libraries/scripting/src/test/java/org/apache/polygene/library/scripting/HelloSpeakerTest.java
+source=libraries/scripting/src/test/groovy/org/apache/polygene/library/scripting/HelloSpeakerTest.java
 tag=script
 ----

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/libraries/scripting/src/docs/scripting.txt
----------------------------------------------------------------------
diff --git a/libraries/scripting/src/docs/scripting.txt b/libraries/scripting/src/docs/scripting.txt
index 7198fc4..90f481a 100644
--- a/libraries/scripting/src/docs/scripting.txt
+++ b/libraries/scripting/src/docs/scripting.txt
@@ -34,7 +34,7 @@ The Scripting Library is a Generic mixin class that implements
 Composite interfaces by delegating to script functions using Java Scripting API. All Java
Scripting API (JSR-223)
 implementations that support
 
-[code,java]
+[source,java]
 ----
     ((javax.script.Invocable) scriptEngine).invokeFunction( functionName, arguments );
 ----

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/SQLVendorProvider.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/SQLVendorProvider.java
b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/SQLVendorProvider.java
index 6a91dc9..d3332a5 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/SQLVendorProvider.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/SQLVendorProvider.java
@@ -20,7 +20,9 @@
 package org.apache.polygene.library.sql.generator.vendor;
 
 import java.io.IOException;
+import java.util.Iterator;
 import java.util.ServiceLoader;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class provides easy way of acquiring vendors for specific databases.
@@ -46,7 +48,13 @@ public class SQLVendorProvider
     public static <VendorType extends SQLVendor> VendorType createVendor( Class<VendorType>
vendorClass )
         throws IOException
     {
+        LoggerFactory.getLogger( SQLVendorProvider.class ).info( "Trying to load implementation
for " + vendorClass.getName() );
         ServiceLoader<VendorType> load = ServiceLoader.load( vendorClass );
-        return load.iterator().next();
+        Iterator<VendorType> vendorTypeIterator = load.iterator();
+        if( vendorTypeIterator.hasNext() )
+        {
+            return vendorTypeIterator.next();
+        }
+        throw new InternalError( "ServiceLoader of SQLVendor implementations is not finding
the META-INF/services" );
     }
 }

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/manual/src/docs/userguide/tools.txt
----------------------------------------------------------------------
diff --git a/manual/src/docs/userguide/tools.txt b/manual/src/docs/userguide/tools.txt
index 2d14312..b621669 100644
--- a/manual/src/docs/userguide/tools.txt
+++ b/manual/src/docs/userguide/tools.txt
@@ -32,11 +32,11 @@ The tools are available in the +tools/+ directory of the Polygeneâ„¢ SDK.
 
 :leveloffset: 2
 
-include::../../../../tools/src/docs/yeoman_polygene.txt[]
+include:: ../../../tools/src/docs/yeoman_polygene.txt[]
 
 :leveloffset: 2
 
-include::../../../../tools/src/docs/envisage.txt[]
-// include::../../../../tools/envisage/src/docs/envisage.txt[]
+include:: ../../../tools/src/docs/envisage.txt[]
+// include:: ../../../tools/envisage/src/docs/envisage.txt[]
 
 :leveloffset: 2

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/manual/src/docs/website/intro.txt
----------------------------------------------------------------------
diff --git a/manual/src/docs/website/intro.txt b/manual/src/docs/website/intro.txt
index c5524f2..fe240f1 100644
--- a/manual/src/docs/website/intro.txt
+++ b/manual/src/docs/website/intro.txt
@@ -28,7 +28,7 @@ include::../../../../tutorials/introduction/src/docs/highlights.txt[]
 
 :leveloffset: 2
 
-include::../../../../tools/shell/src/docs/quick-start.txt[]
+include::../../../../tools/src/docs/yeoman_polygene.txt[]
 
 :leveloffset: 2
 

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/manual/src/docs/website/resources/css/style.css
----------------------------------------------------------------------
diff --git a/manual/src/docs/website/resources/css/style.css b/manual/src/docs/website/resources/css/style.css
index a42d538..e4cd1e9 100644
--- a/manual/src/docs/website/resources/css/style.css
+++ b/manual/src/docs/website/resources/css/style.css
@@ -162,7 +162,7 @@ h2.title
 {
 }
 
-.sub-nav .toc
+.sub-nav div.toc
 {
     position: absolute;
     top: 65px;

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/eec1660f/tools/src/docs/yeoman_polygene.txt
----------------------------------------------------------------------
diff --git a/tools/src/docs/yeoman_polygene.txt b/tools/src/docs/yeoman_polygene.txt
index 10c0f2c..250ece2 100644
--- a/tools/src/docs/yeoman_polygene.txt
+++ b/tools/src/docs/yeoman_polygene.txt
@@ -113,7 +113,6 @@ will be used by any of the entity stores that uses the internal MapEntityStore
S
 ---------------------------
 
 === Serialization system ===
----------------------------
 Serialization is a key concept in business applications, and in Polygene that is a pluggable
subsystem.
 
 ? Which serialization system do you want to use?
@@ -224,7 +223,7 @@ $ yo polygene --import=../model.json --noPrompt
 
 where the content of the +../model.json+ is as follows,
 
-[source,json]
+[source]
 ----
 {
   "name": "Sink",


Mime
View raw message