Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various typos in docs/ subdirectory #2550

Merged
merged 2 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/code/writing-tests.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ _test.hal_ below the directories specified on the command line, or under
represent three different ways to run the tests.

The _runtests_ script accepts the following arguments, see the output
from `scripts/runtests -h` for the authorative list:
from `scripts/runtests -h` for the authoritative list:
----
-n do not remove temporary files for successful tests.
-s stop after any failed test.
Expand Down Expand Up @@ -78,7 +78,7 @@ test.hal::
expected file, the test succeeds.

checkresult::
An excutable file to perform more complex validation than just comparing
An executable file to perform more complex validation than just comparing
the output of a test script. It gets the filename of the test program as
its command line argument. The exit code of this program controls the result
of the test. If both `expected` and `checkresult` exist, only `checkresult`
Expand Down
2 changes: 1 addition & 1 deletion docs/src/config/iov2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Additional pins added by I/O Control V2
Usage: UI informational. Valid during emc-abort TRUE.

* start-change: (Bit, Out) asserted at the very beginning of an M6 operation,
before any spindle-off, quill-up, or move-to-toolchange-position oeprations
before any spindle-off, quill-up, or move-to-toolchange-position operations
are executed.

* start-change-ack: (Bit, In) acknowledgment line for start-change.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/config/moveoff.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Applied offsets are 'automatically returned' to zero (respecting limits)
when either of the enabling inputs is deactivated. The zero value
tolerance is specified by the epsilon input pin value.

Waypoints are recorded when the moveoff componenent is enabled. Waypoints are
Waypoints are recorded when the moveoff component is enabled. Waypoints are
managed with the waypoint-sample-secs and waypoint-threshold pins. When the
backtrack-enable pin is TRUE, the auto-return path follows the recorded
waypoints. When the memory available for waypoints is exhausted, offsets are
Expand Down
4 changes: 2 additions & 2 deletions docs/src/drivers/mesa_modbus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ some realtime implementations of LinuxCNC realtime require that modules
be kernel modules, and kernel modules have no access to files, the
mesa_modbus framework compiles-in the modbus register structure and
HAL pins into an immutable, loadable, module. If you need to change
the register assigments or add/remove pins/registers then the module
the register assignments or add/remove pins/registers then the module
must be recompiled.

Load and activate the module with HAL commands such as
Expand Down Expand Up @@ -334,7 +334,7 @@ reversed.
=== Ad-hoc Modbus device access ===

For experimentation and one-off configuration it is possible to send /
recieve data through the FPGA serial port using the mesaflash utility
receive data through the FPGA serial port using the mesaflash utility
in a script. A sample script follows.

[source,bash]
Expand Down
6 changes: 3 additions & 3 deletions docs/src/getting-started/getting-linuxcnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This section describes how to install LinuxCNC version 2.9 on a PC already running Debian Bookworm (Debian 12). Linuxcnc requires the PREEMPT_RT real time kernel to ensure the strict timing required for CNC operations are met. We will also cover how to install Debian Bookworm optimised for Linuxcnc on the x86/AMD64 and ARM64 platforms for first time users. We will also cover some troubleshooting steps and common problems you may experience.

NOTE: The PREEMPT_RT kernel is a dependency of LinuxCNC so on most computer platforms, eg AMD64/x86, it will be installed with LinuxCNC. On some platforms such as the Raspberry Pi, it needs to be installed seperately. Some environments (eg. Armbian) may suport installation of Debian Bookworm but require special procedures to install PREEMPT_RT which are beyond the scope of this document.
NOTE: The PREEMPT_RT kernel is a dependency of LinuxCNC so on most computer platforms, eg AMD64/x86, it will be installed with LinuxCNC. On some platforms such as the Raspberry Pi, it needs to be installed separately. Some environments (eg. Armbian) may support installation of Debian Bookworm but require special procedures to install PREEMPT_RT which are beyond the scope of this document.

There are other versions of LinuxCNC which work with Xenomai and RTAI kernels. See the table at the end of this document for details.

Expand Down Expand Up @@ -44,7 +44,7 @@ uname -v
----
PREEMPT_RT should be displayed in the results.

Thats it! You are done! You will find LinuxCNC under the CNC menu.
That's it! You are done! You will find LinuxCNC under the CNC menu.


[[sec:bookworm_x86]]
Expand Down Expand Up @@ -98,7 +98,7 @@ Add your user to the sudo group. Type:
----
usermod -aG sudo pi
----
To update your system, and istall the real time kernel, type the following lines:
To update your system, and install the real time kernel, type the following lines:

----
apt update
Expand Down
6 changes: 3 additions & 3 deletions docs/src/gui/gladevcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1489,7 +1489,7 @@ The `HAL_Offset` widget is used to display the offset of a single axis.
`HAL_Offset` has the following properties:

display_units_mm::
Disply in metric units.
Display in metric units.
joint_n_umber::
Used to select which axis (technically which joint) is displayed. +
On a trivialkins machine (mill, lathe, router) axis vs. joint number are:
Expand Down Expand Up @@ -1551,11 +1551,11 @@ font_weight::
Specify the weight of the font. Select from lighter, normal, bold, or bolder.
Default is bold
unhomed_color::
The text color when unhomed pecified as a Gdk.RGBA color.
The text color when unhomed specified as a Gdk.RGBA color.
Default is red,
Gdk.RGBA(red=1.000000, green=0.000000, blue=0.000000, alpha=1.000000)
homed_color::
The text color when homed pecified as a Gdk.RGBA color.
The text color when homed specified as a Gdk.RGBA color.
Default is green,
Gdk.RGBA(red=0.000000, green=0.501961, blue=0.000000, alpha=1.000000)
Hints::
Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/gmoccapy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ The widget names can the looked up in the /usr/share/gmoccapy.glade file
=== User CSS File

Similar to the User command file it's possible to influence the appearance by cascading style sheets (CSS).
If a file `~/.gmoccapy_css` exists, its contents are loaded into the stylesheet provider and are so beeing applied to the GUI.
If a file `~/.gmoccapy_css` exists, its contents are loaded into the stylesheet provider and are so being applied to the GUI.

A configuration-specific CSS file may be specified with an INI file setting
[source,{ini}]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/qtdragon.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ These optional HAL files will be called after QtDragon has loaded everything els
You can add multiple line for multiple file. Each one will be called in the order they appear. +
Calling HAL files after QtDragon is already loaded assures that QtDragon's HAL pins are available.

.Sample with typical entries for the specificion of HAL files to be read after the QtDragon was startd. Adjust these lines to match actual requirements.
.Sample with typical entries for the specificion of HAL files to be read after the QtDragon was started. Adjust these lines to match actual requirements.
[source,{ini}]
----
[HAL]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/gui/qtvcp-widgets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1879,9 +1879,9 @@ To use `MDITouchy`:
On the left will show the entry fields that can be filled out.
* Then press `Next` and `Back` to navigate between fields.
* `Calc` will pop up a calculator dialog.
* `Clear` clears the ecurrent entry.
* `Clear` clears the current entry.
* `Set Tool` will call for a tool change.
* `Set Origin` will allow setting the origin of the current G6x systen.
* `Set Origin` will allow setting the origin of the current G6x system.
* `Macro` will call any available macro ngc programs.

The widget _requires an explicit call to MDITouchy Python code_ to _actually run the MDI command_:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/qtvcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ qtvcp copy_dialog

* Select the screen and destination folder in the dialog
* If you wish to *name your screen* differently than the builtin screen's default name, change the _basename_ in the edit box.
* There should be a folder in the config folder; for screens: named '<CONFIG FOLDER>/qtvcp/screens/' for panels: named '<CONFIG FOLDER>/qtvcp/panels/' add the folders if ther are missing and copy your folder/files in it.
* There should be a folder in the config folder; for screens: named '<CONFIG FOLDER>/qtvcp/screens/' for panels: named '<CONFIG FOLDER>/qtvcp/panels/' add the folders if they are missing and copy your folder/files in it.
* Validate to copy all the files
* Delete the files you don't wish to modify so that the original files will be used.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/hal/comp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
== Introduction

This section introduces to the compilation HAL components, i.e. the addition of some machinists' knowledge on how to deal with the machine.
It should be noted that such components do not neccessarily deal with the hardware directly.
It should be noted that such components do not necessarily deal with the hardware directly.
They often do, but not necessarily, e.g. there could be a component to convert between imperial and metric scales,
so this section does not require to dive into the interaction with hardware.

Expand Down Expand Up @@ -595,7 +595,7 @@ pin out float example;

This fragment of a component illustrates the use of the 'hal_' prefix in a component name.

`loop` is a common name, and the `hal_` prefix avoids potential name collissions with other unrelated software. For example, on RTAI realtime systems realtime code runs in the kernel, so if the component were named just `loop` it could easily conflict with the standard `loop` kernel module.
`loop` is a common name, and the `hal_` prefix avoids potential name collisions with other unrelated software. For example, on RTAI realtime systems realtime code runs in the kernel, so if the component were named just `loop` it could easily conflict with the standard `loop` kernel module.

When loaded, 'halcmd show comp' will show a component called 'hal_loop'.
However, the pin shown by 'halcmd show pin' will be 'loop.0.example', not 'hal-loop.0.example'.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/hal/halshow.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:ngc: {basebackend@docbook:'':ngc}

The script `halshow` can help you find your way around a running HAL.
It displays chosen HAL values and updates them continously.
It displays chosen HAL values and updates them continuously.

This is a very specialized system and it must connect to a working HAL.
It cannot run standalone because it relies on the ability of HAL to "introspect" and report what it knows of itself through the halcmd interface library.
Expand Down Expand Up @@ -122,7 +122,7 @@ The second pin's name contains the complete name of the first.
****
Selected text inside the Show tab can be copied by right-click or CTRL-C. +
The Show area allows to add pins from selected text by using the right-click menu.
All valid pins that are enclosed in the selction are added to the Watch tab.
All valid pins that are enclosed in the selection are added to the Watch tab.
****

== Watch Tab Area
Expand Down
2 changes: 1 addition & 1 deletion docs/src/hal/rtcomps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This chapter provides details on core functionalities of LinuxCNC that demand exact timing for

* the generation of signals that is intepreted by hardware (like motors) or
* the generation of signals that is interpreted by hardware (like motors) or
* for the interpretation of signals sent by the hardware (like encoders).

[[sec:stepgen]]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/man1/mqtt-publisher.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ debian this is available from the `python3-paho-mqtt` package.

The name of HAL pins, signals and other values to publish using
MQTT. The names are also used as the JSON keys in the MQTT
message publised with the broker.
message published with the broker.

*--dryrun*::

Expand Down
6 changes: 3 additions & 3 deletions docs/src/man/man3/hm2_pktuart.3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ every servo thread, and these can be read with the functions
rtapi_u32 hm2_pktuart_get_rx_status() and
rtapi_u32 hm2_pktuart_get_tx_status().

=== Acessing the UARTs ===
=== Accessing the UARTs ===

The UART functions above can be included in your driver code by
``#include "hostmot2-serial.h"``
Expand Down Expand Up @@ -155,7 +155,7 @@ period.

These functions will always return the latest status from the most
recent data packet from the FPGA. The status should be used to check if
any new data has been recieved, or if the UART has completed the recent
any new data has been received, or if the UART has completed the recent
transmissions.

The Tx status is encoded as:
Expand Down Expand Up @@ -207,7 +207,7 @@ frames to include "bytes" bytes.
Both the Tx and Rx pack the bytes that are to be read or written in
32-bit "frames" stored in a 16-deep FIFO.

To send the sequence 01, 02, 03, 04, 05, 06 folowed by the sequence
To send the sequence 01, 02, 03, 04, 05, 06 followed by the sequence
F1, F2, F3, F3, F5, F6, F7 the registers
would be loaded with:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/plasma/qtplasmac.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2271,7 +2271,7 @@ It is possible to use near-end-of-life consumables for piercing and then they ca
.*Puddle Jump*

*Puddle Jump* is the height that the torch will move to after piercing and prior to moving to *Cut Height* and is expressed as a percentage of *Pierce Height*.
This allows the torch to clear any puddle of molten material tht may be caused by piercing.
This allows the torch to clear any puddle of molten material that may be caused by piercing.
The maximum allowable height is 200% of the *Pierce Height*

Setting for *Puddle Jump* are described in <<plasma:material,cut parameters>>
Expand Down