From 0eafcda43801cd1d9bee4299630f5982438245b9 Mon Sep 17 00:00:00 2001 From: Gaston-G Date: Thu, 11 Aug 2022 13:24:36 -0300 Subject: [PATCH] Minor fixes to the documentation. --- doc/src/asciidoc/contributing.adoc | 2 +- doc/src/asciidoc/module_binlog.adoc | 4 ++-- doc/src/asciidoc/module_cryptoservice.adoc | 2 +- doc/src/asciidoc/module_database_support.adoc | 2 +- doc/src/asciidoc/module_dbsupport.adoc | 4 ++-- doc/src/asciidoc/module_txn.adoc | 2 +- doc/src/asciidoc/overview.adoc | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/src/asciidoc/contributing.adoc b/doc/src/asciidoc/contributing.adoc index 82fb64c37a..5da2b9aecb 100644 --- a/doc/src/asciidoc/contributing.adoc +++ b/doc/src/asciidoc/contributing.adoc @@ -68,7 +68,7 @@ Tabs must be set exactly every 8 spaces (not 4). Due to our revision control system, we also need that hard tabs (ASCII 0x09) are not used in source code and configuration files (in order for -diff to work properly among platforms. +diff to work properly among platforms). For 'vi' users, we are using the following .vimrc: diff --git a/doc/src/asciidoc/module_binlog.adoc b/doc/src/asciidoc/module_binlog.adoc index cf107832b7..16b97c0a47 100644 --- a/doc/src/asciidoc/module_binlog.adoc +++ b/doc/src/asciidoc/module_binlog.adoc @@ -66,7 +66,7 @@ main methods: While iterating over a BinLog, it might make sense to persistently store its `BinLog.Ref` in order to be able to restart the iterator at a given point if required (this is useful -if using the BinLog to implement a Store and Forward. +if using the BinLog to implement a Store and Forward). The `BinLogReader` has two constructors: @@ -160,7 +160,7 @@ at specific places. ==== Supporting CLI commands -The `binlog` CLI command is a subsystem that currently have two commands: +The `binlog` CLI command is a subsystem that currently has three commands: * monitor (to visually monitor a binlog) * cutover (to force a cutover) diff --git a/doc/src/asciidoc/module_cryptoservice.adoc b/doc/src/asciidoc/module_cryptoservice.adoc index bc652c5730..d7bc67573e 100644 --- a/doc/src/asciidoc/module_cryptoservice.adoc +++ b/doc/src/asciidoc/module_cryptoservice.adoc @@ -111,7 +111,7 @@ These are the method's signatures: Here `keyId`, `password`, and `encoded` cryptogram don't require too much explanation, but `jobId` does and here is the rationale. We could have a one-shot `aesDecrypt` method accepting the private key password, but decrypting the AES-256 key using PGP is an expensive operation. In situations -where you have extract a daily file, probably encrypted by just a handful keys, you don't want to decrypt +where you have to extract a daily file, probably encrypted by just a handful keys, you don't want to decrypt the key on every `aesDecrypt` call. We don't want to expose the key to the caller either, so the CryptoService keeps it in a private field. In order to do that, `loadKey` caches the key (until it's unloaded), so it's cheap to call `loadKey` followed by `aesDecrypt`, after the first call where the key is actually decrypted, diff --git a/doc/src/asciidoc/module_database_support.adoc b/doc/src/asciidoc/module_database_support.adoc index af0e78277b..6bee738589 100644 --- a/doc/src/asciidoc/module_database_support.adoc +++ b/doc/src/asciidoc/module_database_support.adoc @@ -41,7 +41,7 @@ For MS-SQL database: ---- -WARNING: Only one of these dependencies should defined in your project. +WARNING: Only one of these dependencies should be defined in your project. === MySQL (R) Support diff --git a/doc/src/asciidoc/module_dbsupport.adoc b/doc/src/asciidoc/module_dbsupport.adoc index 74e0daf642..da87a39b65 100644 --- a/doc/src/asciidoc/module_dbsupport.adoc +++ b/doc/src/asciidoc/module_dbsupport.adoc @@ -104,7 +104,7 @@ that looks like this: Besides standard configuration (c3p0, jdbc, transaction isolation), the `hibernate.cfg.xml` file has a collection of mappings for your application's entities, but jPOS-EE applications are built _à la carte_ -picking modules from the jPOS-EE modules offeering, as well as customer specific modules. +picking modules from the jPOS-EE modules offering, as well as customer specific modules. So if an application wants to use jPOS-EE DB support using say Postgresql backend, and wants to use the `sysconfig` module, and `eeuser` module, you would add the following dependencies: @@ -212,7 +212,7 @@ tables in your secondary database are the same as the primary database. If that' in addition to read an alternate JDBC configuration from your `slave:db.properties` you want to map a different set of entities. -if your config modifier has actually two modifiers, separated by a colon (i.e. `slave:legacy`), +If your config modifier has actually two modifiers, separated by a colon (e.g. `slave:legacy`), then we'd read JDBC and optional properties from the `cfg/slave:db.properties`, but when we scan for mapping files, we use the following pattern `META-INF/org/jpos/ee/modules/legacy:*.xml`. diff --git a/doc/src/asciidoc/module_txn.adoc b/doc/src/asciidoc/module_txn.adoc index fd34568fdb..724d403e39 100644 --- a/doc/src/asciidoc/module_txn.adoc +++ b/doc/src/asciidoc/module_txn.adoc @@ -7,7 +7,7 @@ | *When* | Available in all versions of jPOS-EE. | *Who* | The jPOS.org team. | *Where* | Directory modules/txn available in git repository at github. -| *Why* | This module if useful is your jPOS-EE application uses the *Transaction Manager*. +| *Why* | This module is useful if your jPOS-EE application uses the *Transaction Manager*. | *Status* | Stable. | *License* | <> |================================================================= diff --git a/doc/src/asciidoc/overview.adoc b/doc/src/asciidoc/overview.adoc index 722573ddf0..b0b9aafbc0 100644 --- a/doc/src/asciidoc/overview.adoc +++ b/doc/src/asciidoc/overview.adoc @@ -63,7 +63,7 @@ more comfortable with. === About this document This is the official jPOS-EE documentation that intends to -aggregate everything related to jPOS-EE, including but no limited to: +aggregate everything related to jPOS-EE, including but not limited to: its objectives, specifications, schedule, priorities, organizational chart, road map, change log, coding conventions, core modules, optional modules, license information, etc.