cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ntimof...@apache.org
Subject cayenne git commit: Documentation cleanup
Date Thu, 21 Sep 2017 11:32:04 GMT
Repository: cayenne
Updated Branches:
  refs/heads/master 9f410575b -> a4075721b


Documentation cleanup


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

Branch: refs/heads/master
Commit: a4075721b0bfe0838c14bae4e5c0776e967fea04
Parents: 9f41057
Author: Nikita Timofeev <stariy95@gmail.com>
Authored: Thu Sep 21 14:31:59 2017 +0300
Committer: Nikita Timofeev <stariy95@gmail.com>
Committed: Thu Sep 21 14:31:59 2017 +0300

----------------------------------------------------------------------
 .../src/docbkx/ext-cache-invalidation.xml       | 21 ++++++-----
 .../cayenne-guide/src/docbkx/ext-commit-log.xml | 10 +++---
 .../cayenne-guide/src/docbkx/ext-crypto.xml     | 37 ++++++++++----------
 .../cayenne-guide/src/docbkx/ext-dbcp2.xml      |  4 +--
 .../cayenne-guide/src/docbkx/ext-java8.xml      |  2 +-
 .../cayenne-guide/src/docbkx/ext-jcache.xml     | 12 +++----
 .../cayenne-guide/src/docbkx/ext-joda.xml       |  2 +-
 .../src/docbkx/ext-project-compatibility.xml    |  6 ++--
 .../cayenne-guide/src/docbkx/ext-velocity.xml   |  2 +-
 docs/docbook/cayenne-guide/src/docbkx/part5.xml |  4 +--
 .../cayenne-guide/src/docbkx/queries-mapped.xml |  2 +-
 11 files changed, 51 insertions(+), 51 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-cache-invalidation.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-cache-invalidation.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-cache-invalidation.xml
index e597f42..f3e0a0d 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-cache-invalidation.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-cache-invalidation.xml
@@ -22,10 +22,10 @@
     <title>Cache invalidation extension</title>
     <section>
         <title>Description</title>
-        <para>Cache invalidation module is small extensions that allows easily manage
cache invalidation policy.</para>
+        <para>Cache invalidation module is an extension that allows to define cache
invalidation policy programmatically.</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>
@@ -46,28 +46,27 @@
     <section>
         <title>Usage</title>
         <para>
-            Module supports autoloading mechanism, so no other actions required to start
using it.
-            Just mark you entities with <code>@CacheGroups</code> annotation:
+            Module supports autoloading mechanism, so no other actions required to enable
it.
+            Just mark your entities with <code>@CacheGroups</code> annotation
and you are ready to use it:
             <programlisting language="java"><![CDATA[
 @CacheGroups("some-group")
 public class MyEntity extends _MyEntity {
     // ...
 }]]></programlisting>
-            That's all, now after any modification of <code>MyEntity</code> objects
cache group <code>"some-group"</code>
-            will be invalidated automatically.
+            After any modification of <code>MyEntity</code> objects cache group
<code>"some-group"</code>
+            will be dropped from cache automatically.
             <note>
                 <para>You can read more about cache and cache groups in corresponding
<link linkend="caching-and-fresh-data">chapter</link> of this documentation.</para>
             </note>
         </para>
         <para>
-            In case you need some complex logic of cache invalidation you can disable this
default behaviour and
-            provide you own logic.
+            In case you need some complex logic of cache invalidation you can disable default
behaviour and provide your own.
         </para>
         <para>
-            To do so you need to implement <code>org.apache.cayenne.cache.invalidation.InvalidationHandler</code>
interface and tell Cache Invalidation module to
+            To do so you need to implement <code>org.apache.cayenne.cache.invalidation.InvalidationHandler</code>
interface and setup Cache Invalidation module to
             use it.
-            Let's assume we have our implementation class called <code>CustomInvalidationHandler</code>
that will simply match
-            all entities with <code>"custom-group"</code> cache group:
+            Let's use implementation class called <code>CustomInvalidationHandler</code>
that will simply match
+            all entities' types with <code>"custom-group"</code> cache group
regardless of any annotations:
             <programlisting language="java"><![CDATA[
 public class CustomInvalidationHandler implements InvalidationHandler {
     @Override

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-commit-log.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-commit-log.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-commit-log.xml
index 97c38df..20aec52 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-commit-log.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-commit-log.xml
@@ -25,7 +25,7 @@
         <para>The goal of this module is to capture commit changes and present them
to interested parties in an easy-to-process format.</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>
@@ -46,12 +46,12 @@
     <section>
         <title>Usage</title>
         <para>
-            In order to use <code>commitlog</code> module you need to perform
three easy steps:
+            In order to use <code>commitlog</code> module you need to perform
three steps:
             <orderedlist>
                 <listitem>
-                    <para>Mark all entities that changes you interested in with <code>@org.apache.cayenne.commitlog.CommitLog</code>
annotation</para>
+                    <para>Mark all entities which changes you are interested in with
<code>@org.apache.cayenne.commitlog.CommitLog</code> annotation</para>
                     <programlisting language="java"><![CDATA[
-@CommitLog(ignoredProperties = {"somePropertyToSkip"})
+@CommitLog(ignoredProperties = {"somePrivatePropertyToSkip"})
 public class MyEntity extends _MyEntity {
     // ...
 }]]></programlisting>
@@ -64,7 +64,7 @@ public class MyCommitLogListener implements CommitLogListener {
     @Override
     public void onPostCommit(ObjectContext originatingContext, ChangeMap changes) {
         // ChangeMap will contain all information about changes happened in performed commit
-        // this example will simply print IDs of all inserted objects
+        // this particular example will print IDs of all inserted objects
         changes.getUniqueChanges().stream()
             .filter(change -> change.getType() == ObjectChangeType.INSERT)
             .map(ObjectChange::getPostCommitId)

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-crypto.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-crypto.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-crypto.xml
index 082e640..8381bab 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-crypto.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-crypto.xml
@@ -25,7 +25,7 @@
         <para>Crypto module allows encrypt and decrypt values stored in DB transparently
to your Java app.</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>
@@ -48,17 +48,8 @@
         <section>
             <title>Setup your model and DB</title>
             <para>
-                To use crypto you must prepare your database structure to allow <code>byte[]</code>
storage.
-                Also you should define naming convention to mark encrypted columns and set
appropriate SQL type.
-                Default naming strategy that doesn't require additional setup is using <code>"CRYPTO_"</code>
prefix on columns
-                that will contain encrypted data.
-                If you need to you can change this default strategy by injecting you own
implementation of
-                <code>org.apache.cayenne.crypto.map.ColumnMapper</code> interface.
-                <programlisting language="java"><![CDATA[
-ServerRuntime.builder()
-        .addModule(CryptoModule.extend()
-                .columnMapper(MyColumnMapper.class)
-                .module())]]></programlisting>
+                To use crypto module you must prepare your database to allow <code>byte[]</code>
storage and properly name
+                columns that will contain encrypted values.
             </para>
             <para>
                 Currently supported SQL types that can be used to store encrypted data are:
@@ -66,7 +57,7 @@ ServerRuntime.builder()
                     <listitem>
                         <para>
                             Binary types: <code>BINARY, BLOB, VARBINARY, LONGVARBINARY</code>.
-                            This types are preferred.
+                            These types are preferred.
                         </para>
                     </listitem>
                     <listitem>
@@ -79,8 +70,18 @@ ServerRuntime.builder()
                 </note>
             </para>
             <para>
-                Here is example of how your <code>ObjEntity</code> with two encrypted
and two unencrypted properties
-                can look like in the Cayenne Modeler:
+                Default naming strategy that doesn't require additional setup suggests using
<code>"CRYPTO_"</code> prefix.
+                You can change this default strategy by injecting you own implementation
of
+                <code>org.apache.cayenne.crypto.map.ColumnMapper</code> interface.
+                <programlisting language="java"><![CDATA[
+ServerRuntime.builder()
+        .addModule(CryptoModule.extend()
+                .columnMapper(MyColumnMapper.class)
+                .module())]]></programlisting>
+            </para>
+            <para>
+                Here is an example of how <code>ObjEntity</code> with two encrypted
and two unencrypted properties
+                can look like:
             </para>
             <para><inlinemediaobject>
                 <imageobject>
@@ -91,7 +92,7 @@ ServerRuntime.builder()
         <section>
             <title>Setup keystore</title>
             <para>
-                To perform encryption you must provide <code>KEYSTORE_URL</code>
and <code>KEY_PASSWORD</code> to this module.
+                To perform encryption you must provide <code>KEYSTORE_URL</code>
and <code>KEY_PASSWORD</code>.
                 Currently crypto module supports only Java "jceks" KeyStore.
                 <programlisting language="java"><![CDATA[
 ServerRuntime.builder()
@@ -105,7 +106,7 @@ ServerRuntime.builder()
             <para>
                 Additionally to <code>ColumnMapper</code> mentioned above you
can customize other parts of
                 <code>crypto module</code>.
-                You can enable <code>gzip</code> compression and <code>HMAC</code>
usage (this will ensure integrity of data).
+                You can enable <code>gzip</code> compression and <code>HMAC</code>
usage (later will ensure integrity of data).
                 <programlisting language="java"><![CDATA[
 ServerRuntime.builder()
         .addModule(CryptoModule.extend()
@@ -125,7 +126,7 @@ ServerRuntime.builder()
             </para>
             <note>
                 <para>In addition to Java primitive types (and their object counterparts),
<code>crypto module</code>
-                    by default supports encryption only of <code>java.util.Date</code>,
<code>java.math.BigInteger</code>
+                    supports encryption only of <code>java.util.Date</code>,
<code>java.math.BigInteger</code>
                     and <code>java.math.BigDecimal</code> types.
                 </para>
             </note>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-dbcp2.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-dbcp2.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-dbcp2.xml
index 00097a6..715ebc6 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-dbcp2.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-dbcp2.xml
@@ -27,7 +27,7 @@
         </para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>
@@ -48,7 +48,7 @@
     <section>
         <title>Usage</title>
         <para>
-            To use DBCP2 pool you can just setup it in <code>DataNode</code>
settings in Cayenne Modeler:
+            To use DBCP2 pool you need to setup it in <code>DataNode</code> settings
in Cayenne Modeler:
         </para>
         <para><inlinemediaobject>
             <imageobject>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-java8.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-java8.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-java8.xml
index 912de55..9ee1e70 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-java8.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-java8.xml
@@ -26,7 +26,7 @@
         and <code>java.time.LocalDateTime</code> types for entity attributes</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-jcache.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-jcache.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-jcache.xml
index 4756eae..509d538 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-jcache.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-jcache.xml
@@ -22,10 +22,10 @@
     <title>JCache integration</title>
     <section>
         <title>Description</title>
-        <para>This module allows integrate any JCache (JSR 107) compatible caching
provider with Cayenne.</para>
+        <para>This module allows to integrate any JCache (JSR 107) compatible caching
provider with Cayenne.</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>
@@ -46,16 +46,16 @@
     <section>
         <title>Usage</title>
         <para>
-            All you need is to include this module and any compatible caching provider (e.g.
Ehcache).
-            If required you can provide own implementation of <code>org.apache.cayenne.jcache.JCacheConfigurationFactory</code>
-            to customize cache configuration.
+            To use JCache provider in your app you need to include this module and caching
provider libs (e.g. Ehcache).
+            You can provide own implementation of <code>org.apache.cayenne.jcache.JCacheConfigurationFactory</code>
+            to customize cache configuration if required.
         </para>
         <para>
             For advanced configuration and management please use provider specific options
and tools.
         </para>
         <note>
             <para>You can read about using cache in Cayenne in <link linkend="caching-and-fresh-data">this</link>
chapter.</para>
-            <para>You may alse be interested in <link linkend="ext-cache-invalidation">cache
invalidation</link> extension.</para>
+            <para>You may else be interested in <link linkend="ext-cache-invalidation">cache
invalidation</link> extension.</para>
         </note>
     </section>
 </chapter>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-joda.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-joda.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-joda.xml
index 47fd080..d777b68 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-joda.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-joda.xml
@@ -26,7 +26,7 @@
             <code>org.joda.time.LocalDateTime</code> and <code>org.joda.time.DateTime</code>
types for entity attributes</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-project-compatibility.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-project-compatibility.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-project-compatibility.xml
index eb8fb73..d645098 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-project-compatibility.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-project-compatibility.xml
@@ -24,15 +24,15 @@
         <title>Description</title>
         <para>Since version <emphasis>4.1</emphasis> Cayenne doesn't allow
to load project XML files
             from previous versions as this can lead to unexpected errors in runtime. This
module allows to
-            use project files from older versions performing their upgrade on the fly.
-            This can be useful when using Caynnne models from third-party libraries in your
app.
+            use project files from older versions performing their upgrade on the fly (without
modifying files).
+            This can be useful when using Cayenne models from third-party libraries in your
app.
             <note>
                 <para>You should prefer explicit project upgrade via Cayenne Modeler.</para>
             </note>
         </para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/ext-velocity.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/ext-velocity.xml b/docs/docbook/cayenne-guide/src/docbkx/ext-velocity.xml
index 5ddfc98..4086bdf 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/ext-velocity.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/ext-velocity.xml
@@ -26,7 +26,7 @@
         queries.</para>
     </section>
     <section>
-        <title>Including in a Project</title>
+        <title>Including in a project</title>
         <section>
             <title>Maven</title>
             <para>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/part5.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/part5.xml b/docs/docbook/cayenne-guide/src/docbkx/part5.xml
index 67919f9..ee95291 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/part5.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/part5.xml
@@ -23,8 +23,8 @@
     <xi:include href="ext-cache-invalidation.xml"/>
     <xi:include href="ext-commit-log.xml"/>
     <xi:include href="ext-crypto.xml"/>
-    <xi:include href="ext-dbcp2.xml"/>
-    <xi:include href="ext-java8.xml"/>
+    <!--<xi:include href="ext-dbcp2.xml"/>-->
+    <!--<xi:include href="ext-java8.xml"/>-->
     <xi:include href="ext-jcache.xml"/>
     <xi:include href="ext-joda.xml"/>
     <xi:include href="ext-project-compatibility.xml"/>

http://git-wip-us.apache.org/repos/asf/cayenne/blob/a4075721/docs/docbook/cayenne-guide/src/docbkx/queries-mapped.xml
----------------------------------------------------------------------
diff --git a/docs/docbook/cayenne-guide/src/docbkx/queries-mapped.xml b/docs/docbook/cayenne-guide/src/docbkx/queries-mapped.xml
index b80e828..c3d7dd1 100644
--- a/docs/docbook/cayenne-guide/src/docbkx/queries-mapped.xml
+++ b/docs/docbook/cayenne-guide/src/docbkx/queries-mapped.xml
@@ -25,7 +25,7 @@
         Difference between <code>MappedSelect</code> and <code>MappedExec</code>
is (as reflected in their names)
         whether underlying query intended to select data or just to perform some generic
SQL code.
         <note>
-            <para>This queries are "fluent" versions of deprecated <code>NamedQuery</code>
class.</para>
+            <para>These queries are "fluent" versions of deprecated <code>NamedQuery</code>
class.</para>
         </note>
     </para>
     <para>


Mime
View raw message