Skip to content

Commit

Permalink
Merge pull request #260 from Gaston-G/master
Browse files Browse the repository at this point in the history
Minor fixes to the documentation
  • Loading branch information
ar authored Aug 11, 2022
2 parents bc9ceff + 0eafcda commit 11b0a18
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/src/asciidoc/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions doc/src/asciidoc/module_binlog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/src/asciidoc/module_cryptoservice.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion doc/src/asciidoc/module_database_support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ For MS-SQL database:
</dependency>
----
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
Expand Down
4 changes: 2 additions & 2 deletions doc/src/asciidoc/module_dbsupport.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion doc/src/asciidoc/module_txn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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* | <<appendix_license,GNU Affero General Public License version 3>>
|=================================================================
Expand Down
2 changes: 1 addition & 1 deletion doc/src/asciidoc/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 11b0a18

Please sign in to comment.