Skip to content

Commit

Permalink
fix docs typo (locka99#144)
Browse files Browse the repository at this point in the history
* fix docs typo

* add missing quote
  • Loading branch information
jijun99 authored Nov 27, 2021
1 parent 949dd7f commit b015afd
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ trust the server. The name of this file is derived from information in the certi
to make a unique file.

If we had told the client not to trust the server, the cert would have appeared
under `/pki/rejected` and we would need to move it manually moved it into the `/pki/trusted` folder. This
under `/pki/rejected` and we would need to move it manually into the `/pki/trusted` folder. This
is what you should do in production.

#### Make your server trust your client
Expand Down
4 changes: 2 additions & 2 deletions docs/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Hashing functions are used to produce message authentication codes and for signi

## Pseudo-random generator

OPC UA for Rust creates nonces through through a secure random function provided by OpenSSL. OpenSSL in turn utilizes
OPC UA for Rust creates nonces through a secure random function provided by OpenSSL. OpenSSL in turn utilizes
functions provided by the operating system that ensure sufficient entropy in their result. This is encapsulated by a
couple of functions:

Expand Down Expand Up @@ -97,7 +97,7 @@ OPC UA for Rust doesn't enforce a minimum key length although the OPC UA Specifi
no less than 1024 bits for the Basic128Rsa15 profile and 2048 bits or more for other profiles. It also recommends
that a key length of < 2048 bits be deprecated.

Private keys are stored in DER and public certs are stored on disk in PEM format and loaded into memory when required.
Private keys are stored in PEM and public certs are stored on disk in DER format and loaded into memory when required.

NOTE: Future impls may favour .pem for both certs & keys to allow for chained signing of certificates.

Expand Down
4 changes: 2 additions & 2 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ A `Variant` is a special catch-all enum which can hold any other primitive or ba

Machine generated types reside in `types/src/service_types`. The `enums.rs` holds all of the enumerations. A special `impls.rs` contains additional hand written functions that are associated with types.

The `tools/schema/` directory contains NodeJS scripts that will generate Rust code from from OPC UA schemas.
The `tools/schema/` directory contains NodeJS scripts that will generate Rust code from OPC UA schemas.

* Status codes
* Node Ids (objects, variables, references etc.)
Expand Down Expand Up @@ -181,7 +181,7 @@ Rust enables the `body` payload to be `None`, `ByteString` or `XmlElement` and t

### Lint exceptions for OPC UA

OPC UA has some some really long PascalCase ids, many of which are further broken up by underscores. I've tried converting the name to upper snake and they look terrible. I've tried removing underscores and they look terrible.
OPC UA has some really long PascalCase ids, many of which are further broken up by underscores. I've tried converting the name to upper snake and they look terrible. I've tried removing underscores and they look terrible.

So the names and underscores are preserved as-in in generated code even though they generate lint errors. The lint rules are disabled for generated code.

Expand Down
2 changes: 1 addition & 1 deletion docs/opc_ua_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[OPC UA](https://opcfoundation.org/) is a communication protocol for industrial visualization and control systems. It allows a client to connect to a server over a secure/insecure channel and call services on the server in order to monitor variables, call methods and other activities.

A server listens for connections on a port. A client first connects to that port. It then queries what _endpoints_ the server supports. Endpoints describe different ways of interacting with the server including their security policy. The client will then connect to an endpoint, handshake and establish and active a session with an identity token. Once activated the client can call services on the server.
A server listens for connections on a port. A client first connects to that port. It then queries what _endpoints_ the server supports. Endpoints describe different ways of interacting with the server including their security policy. The client will then connect to an endpoint, handshake and establish and activate a session with an identity token. Once activated the client can call services on the server.

OPC UA is very complex to implement (spanning 14 volumes of specification) so it is broken down into a series of profiles that build on each other and describe what features a server should implement.

Expand Down
2 changes: 1 addition & 1 deletion docs/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To use the server crate we need to add an dependency to the `Cargo.toml`.

```
[dependencies]
opcua-server = "0.8.0
opcua-server = "0.8.0"
```

## Import types
Expand Down

0 comments on commit b015afd

Please sign in to comment.