¶
-Some perations require multiple rounds of communication.
+
Some operations require multiple rounds of communication.
In this case payloads are send in a sequence. Payload that is not part of this
-specific operation (for example incomming message) cannot interrupt this process.¶
-
+specific operation (for example incoming message) cannot interrupt this process.
¶
+
-
-2.5.1. Connection initialization
+
-- Client: Initialize TCP connection.¶
+
- Client: Initialise TCP connection.¶
- Client: Send handshake.¶
diff --git a/docs/rfc.md b/docs/rfc.md
index 089d93f..db79839 100644
--- a/docs/rfc.md
+++ b/docs/rfc.md
@@ -42,10 +42,10 @@ protocol to keep required bandwidth as low as possible.
Current implementation works on top of TCP/IP stack. In future, SOLEC will be
adapted to work over LoRa.
-## Decentralization
+## Decentralisation
-Recurring problem with modern day instant messaging is its centralization.
-SOLEC solves is it in similair fashion to XMPP or SMTP. SOLEC servers exchange
+Recurring problem with modern day instant messaging is its centralisation.
+SOLEC solves is it in similar fashion to XMPP or SMTP. SOLEC servers exchange
messages between each other so the users using server A can reach out users
using server B.
@@ -82,11 +82,11 @@ SOLEC is using Type Length Value (TLV) structure for data exchange.
Figure: SOLEC PDU Layout
* Type (8):
-Payload type is indicated by 1 octed which gives 256 types that can be
+Payload type is indicated by 1 octet which gives 256 types that can be
represented.
* Length (16):
-Payload length is 2 octets. It indicates lenght of the payload field.
+Payload length is 2 octets. It indicates length of the payload field.
The length does not include type and length fields.
* Payload (variable):
@@ -100,7 +100,7 @@ does not carry any data.
## Data types
-Data typres are basic types that are used in construction of more comples
+Data types are basic types that are used in construction of more complex
payload types.
### Numeric types
@@ -146,7 +146,7 @@ Figure: String Layout
Payload type attributes describes following characteristics:
-* R - Reserved: implementattion should ignore payloads of this type
+* R - Reserved: implementation should ignore payloads of this type
* S - Server: can be send only by a server
* C - Client: can be send only by a client
* E - Empty: signals an event but does not carry any data
@@ -248,13 +248,13 @@ should ignore this kind of payload.
## Sequential operations
-Some perations require multiple rounds of communication.
+Some operations require multiple rounds of communication.
In this case payloads are send in a sequence. Payload that is not part of this
-specific operation (for example incomming message) cannot interrupt this process.
+specific operation (for example incoming message) cannot interrupt this process.
-### Connection initialization
+### Connection initialisation
-- Client: Initialize TCP connection.
+- Client: Initialise TCP connection.
- Client: Send *handshake*.
- Server: If *major* version of protocol differs close the connection.
- Server: Otherwise send *handshake*.
diff --git a/docs/rfc.txt b/docs/rfc.txt
index a53f170..8d889df 100644
--- a/docs/rfc.txt
+++ b/docs/rfc.txt
@@ -15,7 +15,7 @@ Abstract
Table of Contents
1. Introduction
- 1.1. Decentralization
+ 1.1. Decentralisation
1.2. User to user communication
1.3. Channels
2. Network protocol
@@ -33,7 +33,7 @@ Table of Contents
2.4.5. Message
2.4.6. Test
2.5. Sequential operations
- 2.5.1. Connection initialization
+ 2.5.1. Connection initialisation
1. Introduction
@@ -47,10 +47,10 @@ Table of Contents
Current implementation works on top of TCP/IP stack. In future,
SOLEC will be adapted to work over LoRa.
-1.1. Decentralization
+1.1. Decentralisation
Recurring problem with modern day instant messaging is its
- centralization. SOLEC solves is it in similair fashion to XMPP or
+ centralisation. SOLEC solves is it in similar fashion to XMPP or
SMTP. SOLEC servers exchange messages between each other so the
users using server A can reach out users using server B.
@@ -85,10 +85,10 @@ Table of Contents
Figure: SOLEC PDU Layout
- * Type (8): Payload type is indicated by 1 octed which gives 256
+ * Type (8): Payload type is indicated by 1 octet which gives 256
types that can be represented.
- * Length (16): Payload length is 2 octets. It indicates lenght of
+ * Length (16): Payload length is 2 octets. It indicates length of
the payload field. The length does not include type and length
fields.
@@ -103,8 +103,8 @@ Table of Contents
2.3. Data types
- Data typres are basic types that are used in construction of more
- comples payload types.
+ Data types are basic types that are used in construction of more
+ complex payload types.
2.3.1. Numeric types
@@ -145,7 +145,7 @@ Table of Contents
Payload type attributes describes following characteristics:
- * R - Reserved: implementattion should ignore payloads of this type
+ * R - Reserved: implementation should ignore payloads of this type
* S - Server: can be send only by a server
* C - Client: can be send only by a client
* E - Empty: signals an event but does not carry any data
@@ -249,14 +249,14 @@ Table of Contents
2.5. Sequential operations
- Some perations require multiple rounds of communication. In this
+ Some operations require multiple rounds of communication. In this
case payloads are send in a sequence. Payload that is not part of
- this specific operation (for example incomming message) cannot
+ this specific operation (for example incoming message) cannot
interrupt this process.
-2.5.1. Connection initialization
+2.5.1. Connection initialisation
- * Client: Initialize TCP connection.
+ * Client: Initialise TCP connection.
* Client: Send _handshake_.
* Server: If _major_ version of protocol differs close the
connection.
diff --git a/hooks/pre-commit b/hooks/pre-commit
index 8336947..67a1b19 100755
--- a/hooks/pre-commit
+++ b/hooks/pre-commit
@@ -9,6 +9,8 @@ cd $(git rev-parse --show-toplevel)
echo "Building docs"
make -C docs txt
make -C docs html
+git add docs/rfc.html
+git add docs/rfc.txt
echo "Running tests before commit to main"
go test ./...
--
cgit v1.2.3