Skip to content

Commit

Permalink
fix typos in docs
Browse files Browse the repository at this point in the history
spotted by Aaron, thanks!
  • Loading branch information
marcopioppini committed Dec 16, 2024
1 parent 3d32c7f commit f7b9d70
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Depending on your performance requirements and your specific bottlenecks, the fo
- Using XDP in zero-copy mode can substantially improve performance, but whether it is supported depends on the combination of network card and driver in your setup. Hercules will attempt to use zero-copy mode automatically, if it appears to be supported. Note that some network cards require updating drivers/firmware to enable zero-copy mode.

- Using larger packets (jumbo frames) can also improve performance. Hercules supports jumbo frames up to a MTU of 9000 bytes. Note, however, that support for jumbo frames (via XDP multibuffer/fragments) requires at least kernel 6.6. On older versions the packet size is limited to 3000 bytes.
Further, support for jumbo frames in combination with zero-copy mode is device-dependent. To use jumbo frames on such a device, disable zero-copy in Hercules' file.
Further, support for jumbo frames in combination with zero-copy mode is device-dependent. To use jumbo frames on a device that does not support jumbo frames in zero-copy mode, disable zero-copy in Hercules' configuration file.

- Increasing the number of worker threads via the option `NumThreads` can also improve performance.

Expand Down
2 changes: 1 addition & 1 deletion doc/hercules-monitor.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.Ek
.Sh DESCRIPTION
.Nm
is the monitor component of the Hercules file transfer sytem.
is the monitor component of the Hercules file transfer system.
The monitor is the link between users and the Hercules server.
Users interact with the monitor via its HTTP API.
The monitor interacts with the server component via a local Unix socket.
Expand Down
2 changes: 1 addition & 1 deletion doc/hercules-monitor.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ HERCULES-MONITOR(1) - General Commands Manual
# DESCRIPTION

**hercules-monitor**
is the monitor component of the Hercules file transfer sytem.
is the monitor component of the Hercules file transfer system.
The monitor is the link between users and the Hercules server.
Users interact with the monitor via its HTTP API.
The monitor interacts with the server component via a local Unix socket.
Expand Down
2 changes: 1 addition & 1 deletion doc/hercules-server.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.Ek
.Sh DESCRIPTION
.Nm
is the server component of the Hercules file transfer sytem.
is the server component of the Hercules file transfer system.
The server's task is to run the actual file transfers.
The server receives tasks from the monitor and informs the monitor of
transfer progress via a local Unix socket.
Expand Down
2 changes: 1 addition & 1 deletion doc/hercules-server.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ HERCULES-SERVER(1) - General Commands Manual
# DESCRIPTION

**hercules-server**
is the server component of the Hercules file transfer sytem.
is the server component of the Hercules file transfer system.
The server's task is to run the actual file transfers.
The server receives tasks from the monitor and informs the monitor of
transfer progress via a local Unix socket.
Expand Down
6 changes: 3 additions & 3 deletions doc/hercules.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ for more information.
The following general configuration options are available:
.Bl -tag -width Ds
.It Ic DefaultNumPaths Ns = Ns Ar int
Specify how many SCION path to use for data transfers.
Specify how many SCION paths to use for data transfers.
This is an upper limit, if fewer paths are available only those will be used.
This value may be overridden on a per-destination basis, see
.Sx PER-DESTINATION OVERRIDES .
Expand Down Expand Up @@ -89,7 +89,7 @@ for more information.
When setting this option, note that the file paths supplied by users will be
interpreted relative to this new directory.
.Pp
Example: DropUser = "/mnt/data/"
Example: ChrootDir = "/mnt/data/"
.It Ic EnablePCC Ns = Ns Ar bool
Setting this option to
.Ar false
Expand Down Expand Up @@ -236,7 +236,7 @@ For transfers to any other host in AS
.Em 18-a:b:c :
.Bl -bullet -compact
.It
A payload length of 1400 should be used.
A payload length of 1400B should be used.
.El
.El
.Pp
Expand Down
6 changes: 3 additions & 3 deletions doc/hercules.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following general configuration options are available:

**DefaultNumPaths**=*int*

> Specify how many SCION path to use for data transfers.
> Specify how many SCION paths to use for data transfers.
> This is an upper limit, if fewer paths are available only those will be used.
> This value may be overridden on a per-destination basis, see
> *PER-DESTINATION OVERRIDES*.
Expand Down Expand Up @@ -103,7 +103,7 @@ The following general configuration options are available:
> When setting this option, note that the file paths supplied by users will be
> interpreted relative to this new directory.
> Example: DropUser = "/mnt/data/"
> Example: ChrootDir = "/mnt/data/"
**EnablePCC**=*bool*

Expand Down Expand Up @@ -271,7 +271,7 @@ Example: The following set of rules specifies that
* For transfers to any other host in AS
*18-a:b:c*:

* A payload length of 1400 should be used.
* A payload length of 1400B should be used.

Example:

Expand Down

0 comments on commit f7b9d70

Please sign in to comment.