You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/03/07 10:08:10 UTC
[plc4x] branch develop updated: chore(doc): Fix typos (#328)
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 18eb18f chore(doc): Fix typos (#328)
18eb18f is described below
commit 18eb18f506f1f6b35575637a39e8952361067423
Author: Christian Clauss <cc...@me.com>
AuthorDate: Mon Mar 7 11:08:07 2022 +0100
chore(doc): Fix typos (#328)
---
README.md | 2 +-
RELEASE_NOTES | 4 ++--
plc4j/integrations/apache-kafka/README.md | 10 +++++-----
plc4j/protocols/benchmarks/README.md | 4 ++--
tools/README.md | 4 ++--
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index e3d27e4..0600ab3 100644
--- a/README.md
+++ b/README.md
@@ -116,7 +116,7 @@ https://dev.to/carlos487/installing-dotnet-core-in-ubuntu-1804-7lp
#### Mac
-Make sure `Homebrew` ist installed in order to update `Bison` to a newer version (the version 2.3 installed per default is too old)
+Make sure `Homebrew` is installed in order to update `Bison` to a newer version (the version 2.3 installed per default is too old)
```
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
index a7fb439..4b95569 100644
--- a/RELEASE_NOTES
+++ b/RELEASE_NOTES
@@ -167,7 +167,7 @@ New Features
- The new S7 Driver supports writing multiple entries in one
request (The API allowed this from the beginning now not
every item is wrapped in a single request. It should bring
- significant performance gains when writing multiple vlaues)
+ significant performance gains when writing multiple values)
- S7 Driver now supports String datatypes.
- OSGi : Implementation of Drivers/Transports as OSGi services
to be able to use them in an OSGi container.
@@ -440,4 +440,4 @@ Bug Fixes
PLC4X-20 Jacoco doesn't seem to be working at all
PLC4X-21 Code coverage doesn't seem to work
PLC4X-47 S7 driver silently ignores surplus ReadRequestItems
-PLC4X-48 S7 driver failes to parse response with multiple items
+PLC4X-48 S7 driver fails to parse response with multiple items
diff --git a/plc4j/integrations/apache-kafka/README.md b/plc4j/integrations/apache-kafka/README.md
index 25f16db..74f2235 100644
--- a/plc4j/integrations/apache-kafka/README.md
+++ b/plc4j/integrations/apache-kafka/README.md
@@ -41,7 +41,7 @@ able to be run in two modes:-
Standalone allows you to run the connector locally from the command line without having to install the jar file on your
Kafka brokers.
In distributed mode the connector runs on the Kafka brokers, which requires you to install the jar file on all of your
-brokers. It allows the worker to be distrubuted across the Kafka brokers to provide redundancy and load balancing.
+brokers. It allows the worker to be distributed across the Kafka brokers to provide redundancy and load balancing.
## Quickstart
@@ -163,7 +163,7 @@ being sent to the PLC using the mapping defined in the sink properties.
{"type":"int64","optional":false,"field":"timestamp"},
{"type":"int64","optional":true,"field":"expires"}],
"optional":false,"name":"org.apache.plc4x.kafka.schema.JobResult",
- "doc":"PLC Job result. This contains all of the received PLCValues as well as a recieved timestamp"},
+ "doc":"PLC Job result. This contains all of the received PLCValues as well as a received timestamp"},
"payload":
{"fields":
{"running":false,"conveyorLeft":true,
@@ -216,20 +216,20 @@ connector, the poll rate of the connector has no affect on the PLC poll rate.
For the sink connector, if a write fails it is retried a configurable number of times with a timeout between each time.
A Retriable Exception is raised which provides jitter for the timing of the retries.
-## Schema Compatability
+## Schema Compatibility
PLC4X specifies a very basic schema and leaves the majority of the implementation to the user. It contains the
following fields:-
- "fields": - This is a customized structure that is formed by the fields defined in the connector configuration.
-This allows the user to defined arbitary fields within here all based on the PLC4X data types.
+This allows the user to defined arbitrary fields within here all based on the PLC4X data types.
- "timestamp": - This is the timestamp at which the PLC4X connector processed the PLC request.
- "expires": - This field is used by the sink connector. It allows it to discard the record if it is too old. A value
of 0 or null indicates that the record some never be discarded no matter how old it is.
-As the majority of the schema is left to the user to define we expect to be able to provide backward compatiblity
+As the majority of the schema is left to the user to define we expect to be able to provide backward compatibility
between the base schemas.
The schemas for the sink and source connectors are the same. This allows us to producer from one PLC and send the
diff --git a/plc4j/protocols/benchmarks/README.md b/plc4j/protocols/benchmarks/README.md
index 876a9d3..6ce7ae3 100644
--- a/plc4j/protocols/benchmarks/README.md
+++ b/plc4j/protocols/benchmarks/README.md
@@ -20,11 +20,11 @@ The benchmarks module contains micro-benchmarks for multiple protocols.
It uses JMH for benchmarking (http://openjdk.java.net/projects/code-tools/jmh/)
-The recommendation from JMH id to run bechmarks in a separate module like this one:
+The recommendation from JMH id to run benchmarks in a separate module like this one:
_The recommended way to run a JMH benchmark is to use Maven to setup a standalone project that depends on the jar files of your application. This approach is preferred to ensure that the benchmarks are correctly initialized and produce reliable results. It is possible to run benchmarks from within an existing project, and even from within an IDE, however setup is more complex and the results are less reliable._
Source: http://openjdk.java.net/projects/code-tools/jmh/
To run the test you can use a plugin for your IDE. If you want to use maven you can use the profile `run-benchmark`:
-`mvn -Prun-benchmark verify`
\ No newline at end of file
+`mvn -Prun-benchmark verify`
diff --git a/tools/README.md b/tools/README.md
index cfe18df..2167be8 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -28,7 +28,7 @@ If you're building a source-distribution and haven't installed git yet, be sure
# MAC
-Make sure `Homebrew` ist installed in order to update `Bison` to a newer version (the version 2.3 installed per default is too old)
+Make sure `Homebrew` is installed in order to update `Bison` to a newer version (the version 2.3 installed per default is too old)
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
@@ -69,4 +69,4 @@ You can get Python from here: https://www.python.org/downloads/release/python-27
Make sure the `bin` directories of containing the executables `mingw32-make.exe`, `bison.exe` and `flex.exe` are all on your systems `PATH`.
-If you're building a source-distribution and haven't installed git yet, be sure to do so.
\ No newline at end of file
+If you're building a source-distribution and haven't installed git yet, be sure to do so.