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

docs: remove bad unicode characters #1677

Merged
merged 1 commit into from
Mar 24, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions debian/copyright
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ License: LGPL-2
with this program. If not, see <https://www.gnu.org/licenses/>
.
On Debian systems, the complete text of the GNU Lesser General Public
License version 2.1 can be found in /usr/share/common-licenses/LGPL-2.
License version 2.1 can be found in '/usr/share/common-licenses/LGPL-2'.

License: LGPL-2.1+
This program is free software; you can redistribute it and/or modify
Expand All @@ -501,7 +501,7 @@ License: LGPL-2.1+
with this program. If not, see <https://www.gnu.org/licenses/>
.
On Debian systems, the complete text of the GNU Lesser General Public
License version 2.1 can be found in /usr/share/common-licenses/LGPL-2.1.
License version 2.1 can be found in '/usr/share/common-licenses/LGPL-2.1'.

License: MIT
Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
8 changes: 4 additions & 4 deletions docs/man/man1/hal_parport.1
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,17 @@ The following lists the input and output pins by the type setting used in the cf
Reads physical input pins of all ports and updates HAL \-in and \-in\-not pins.
.TP
\fBparport.<p>.write (funct)
Reads HAL \-out pins of port <p> and updates that ports physical output pins.
Reads HAL \-out pins of port <p> and updates that port's physical output pins.
.TP
\fBparport.write\-all (funct)
Reads HAL \-out pins of all ports and updates all physical output pins.
.TP
\fBparport.<p>.reset (funct)
Waits until \fIreset\-time \fRhas elapsed since the associated write, then resets pins to values indicated by \fI\-out\-reset \fRand \fI\-out\-invert \fRsettings. reset must be later in the same thread as write. 'If '\fI\-out\-reset \fRis TRUE, then the reset function will set the pin to the value of \fI\-out\-invert\fR. This can be used in conjunction with stepgens doublefreq to produce one step per period. The stepgen stepspace for that pin must be set to 0 to enable doublefreq.
Waits until \fIreset\-time \fRhas elapsed since the associated write, then resets pins to values indicated by \fI\-out\-reset \fRand \fI\-out\-invert \fRsettings. reset must be later in the same thread as write. 'If '\fI\-out\-reset \fRis TRUE, then the reset function will set the pin to the value of \fI\-out\-invert\fR. This can be used in conjunction with stepgen's doublefreq to produce one step per period. The stepgen stepspace for that pin must be set to 0 to enable doublefreq.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here we should use U+2019 [1] or U+02BC [2]

.SH USAGE
The hal_parport component is a driver for the traditional PC parallel port. The port has a total of 25 physical pins of which 17 are used for signals. The original parallel port divided those pins into three groups: data, control, and status. The data group consists of 8 output pins, the control group consists of 4 output pins, and the status group consists of 5 input pins.

In the early 1990s, the bidirectional parallel port was introduced, which allows the data group to be used for output or input. The HAL driver supports the bidirectional port, and allows the user to set the data group as either input or output. If configured as \fIout\fR, a port provides a total of 12 outputs and 5 inputs. If configured as \fIin\fR, it provides 4 outputs and 13 inputs.
In the early 1990's, the bidirectional parallel port was introduced, which allows the data group to be used for output or input. The HAL driver supports the bidirectional port, and allows the user to set the data group as either input or output. If configured as \fIout\fR, a port provides a total of 12 outputs and 5 inputs. If configured as \fIin\fR, it provides 4 outputs and 13 inputs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here


In some parallel ports, the control group pins are open collectors, which may also be driven low by an external gate. On a board with open collector control pins, if configured as \fIx\fR, it provides 8 outputs, and 9 inputs.

Expand Down Expand Up @@ -147,7 +147,7 @@ For each parallel port handled by the hal_parport driver, a type can optionally

If the type is not specified, the default is out.

A type of epp is the same as out, but the hal_parport driver requests that the port switch into EPP mode. The hal_parport driver does not use the EPP bus protocol, but on some systems EPP mode changes the electrical characteristics of the port in a way that may make some marginal hardware work better. The Gecko G540s charge pump is known to require this on some parallel ports.
A type of epp is the same as out, but the hal_parport driver requests that the port switch into EPP mode. The hal_parport driver does not use the EPP bus protocol, but on some systems EPP mode changes the electrical characteristics of the port in a way that may make some marginal hardware work better. The Gecko G540's charge pump is known to require this on some parallel ports.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here also and so on ...
But I am neither a native english speaker nor a linguist. Maybe someone other could help out here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree, those are bad characters too. I will either amend this PR, or start a new one to fix them as well. Thanks!

Edit: Actually those are part of this commit :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I wanted to say is, that the old characters (U+2019) are better than your change in those cases. Another possibility is U+02BC but not U+0027.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I misunderstood your suggestion.

For at least the docs I changed, my understanding is that U+0027 ( ' ) is the correct character as it is part of the Basic Latin Unicode block (encoded in one byte in UTF-8). The look-alike characters can cause syntax errors in code and in terminal commands.

When the English source files are converted to other languages, I am not so sure which characters are correct, that is why I left those files (_es, _fr, _CN, etc.) alone, as well as the .po files (those I left alone because I know they are being worked on).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For at least the docs I changed, my understanding is that U+0027 ( ' ) is the correct character as it is part of the Basic Latin Unicode block (encoded in one byte in UTF-8).

I am not sure. You can read through the references in #1677 (comment) and see that's is not that simple.
But for the singe and double quotes i totally agree.

as well as the .po files (those I left alone because I know they are being worked on).

Not on these which are in the repo, but they are handled by Weblate, so totally correct to not touch them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i figured out that my concerns were without any reason. Asciidoc generates the correct character. (' turns into U+2019 )


See the Note above about mode x.
.TP
Expand Down
6 changes: 3 additions & 3 deletions docs/src/code/code-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ very much a work in progress, and its layout may change in the future.
orientation. A second set of linear orthogonal coordinates U, V, and W
allows tool motion (typically for cutting actions) relative to the
previously offset and rotated axes.
Unfortunately axis is also
Unfortunately "axis" is also
sometimes used to mean a degree of freedom of the machine itself, such
as the saddle, table, or quill of a Bridgeport type milling machine. On
a Bridgeport this causes no confusion, since movement of the table
Expand Down Expand Up @@ -968,8 +968,8 @@ any one buffer is unclear from existing documentation and from the
original source code. Allowing unspecified multiple processes to
connect to a buffer is no more difficult to implement.

The mutex types boil down to one of two, the default os_sem or mao
split. Most of the NML messages are relatively short and can be copied
The mutex types boil down to one of two, the default "os_sem" or "mao
split". Most of the NML messages are relatively short and can be copied
to or from the buffer with minimal delays, so split reads are not
essential.

Expand Down
10 changes: 5 additions & 5 deletions docs/src/code/contributing-to-linuxcnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,8 @@ third commit, add a new feature which is made easier by the refactoring
and which would not have worked without fixing that bug.

This is helpful to reviewers, because it is easier to see that the
"factor out code into new function" step was right when there arent
other edits mixed in; its easier to see that the bug is fixed when
"factor out code into new function" step was right when there aren't
other edits mixed in; it's easier to see that the bug is fixed when
the change that fixes it is separate from the new feature; and so on.

=== Follow the style of the surrounding code
Expand All @@ -207,9 +207,9 @@ done, do it as a commit separate from any semantic changes.

=== Simplify complicated history before sharing with fellow developers

With git, its possible to record every edit and false start as a
With git, it's possible to record every edit and false start as a
separate commit. This is very convenient as a way to create checkpoints
during development, but often you dont want to share these false
during development, but often you don't want to share these false
starts with others.

Git provides two main ways to clean history, both of which can be done
Expand All @@ -218,7 +218,7 @@ freely before you share the change:
`git commit --amend` lets you make additional changes to the last thing
you committed, optionally modifying the commit message as well. Use this
if you realized right away that you left something out of the commit,
or if you typod the commit message.
or if you typo'd the commit message.

`git rebase --interactive upstream-branch` lets you go back through each
commit made since you forked your feature branch from the upstream branch,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/code/style-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When making small edits to code in a style different than the one
described below, observe the local coding style. Rapid changes from one
coding style to another decrease code readability.

Never check in code after running indent on it. The whitespace
Never check in code after running "indent" on it. The whitespace
changes introduced by indent make it more difficult to follow the
revision history of the file.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/common/glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Feedrate Override::
(((feedrate override))) A manual, operator controlled
change in the rate at which the tool moves while cutting. Often used to
allow the operator to adjust for tools that are a little dull, or
anything else that requires the feed rate to be tweaked.
anything else that requires the feed rate to be "tweaked".

Floating Point Number::
A number that has a decimal point. (12.300) In HAL it is known as float.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/config/core-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ See also the man pages 'motion(9)'.
== Motion

These pins and parameters are created by the realtime 'motmod' module.
This module provides a HAL interface for LinuxCNCs motion planner.
This module provides a HAL interface for LinuxCNC's motion planner.
Basically motmod takes in a list of waypoints and generates a nice
blended and constraint-limited stream of joint positions to be fed
to the motor drives.
Expand Down Expand Up @@ -381,7 +381,7 @@ See the motion man page 'motion(9)' for details on the pins and parameters.

== iocontrol

iocontrol accepts NML I/O commands, interacts with HAL in userspace.
iocontrol - accepts NML I/O commands, interacts with HAL in userspace.

The signals are turned on and off in userspace - if you have strict
timing requirements or simply need more i/o, consider using the realtime
Expand Down
6 changes: 3 additions & 3 deletions docs/src/config/iov2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,11 @@ Additional pins added by I/O Control V2

== Parameters

* iocontrol.0.tool-prep-index (s32, RO) IOs internal array index of the prepped
* iocontrol.0.tool-prep-index (s32, RO) IO's internal array index of the prepped
tool requested by the most recent T-word. 0 if no tool is prepped. On random
toolchanger machines this is tools pocket number (ie, the same as the
toolchanger machines this is tool's pocket number (ie, the same as the
tool-prep-pocket pin), on non-random toolchanger machines this is a small
integer corresponding to the tools location in the internal representation of
integer corresponding to the tool's location in the internal representation of
the tool table. This parameter returns to 0 after a successful tool change M6.

== Communications
Expand Down
4 changes: 2 additions & 2 deletions docs/src/config/stepper.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ same pin.

=== Changing polarity of a signal

If external hardware expects an active low signal, set the
If external hardware expects an "active low" signal, set the
corresponding '-invert' parameter. For instance, to invert the spindle
control signal:

Expand All @@ -218,7 +218,7 @@ addf pwmgen.make-pulses base-thread
net spindle-speed-cmd spindle.0.speed-out => pwmgen.0.value
net spindle-on spindle.0.on => pwmgen.0.enable
net spindle-pwm pwmgen.0.pwm => parport.0.pin-09-out
setp pwmgen.0.scale 1800 # Change to your spindles top speed in RPM
setp pwmgen.0.scale 1800 # Change to your spindle's top speed in RPM
----

This assumes that the spindle controller's response to PWM is simple:
Expand Down
12 changes: 6 additions & 6 deletions docs/src/drivers/shuttle.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

== Description

Shuttle is a non-realtime HAL component that interfaces Contour Designs
ShuttleXpress, ShuttlePRO, and ShuttlePRO2 devices with LinuxCNCs HAL.
Shuttle is a non-realtime HAL component that interfaces Contour Design's
ShuttleXpress, ShuttlePRO, and ShuttlePRO2 devices with LinuxCNC's HAL.

If the driver is started without command-line arguments, it will probe
all /dev/hidraw* device files for Shuttle devices, and use all devices
Expand All @@ -30,7 +30,7 @@ returns to center when released.
The Shuttle devices have an internal 8-bit counter for the current
jog-wheel position. The shuttle driver can not know this value until the
Shuttles device sends its first event. When the first event comes into
the driver, the driver uses the devices reported jog-wheel position
the driver, the driver uses the device's reported jog-wheel position
to initialize counts to 0.

This means that if the first event is generated by a jog-wheel move,
Expand Down Expand Up @@ -84,13 +84,13 @@ of the device (the order in which the driver found them), for example
'<Prefix>.spring-wheel-s32' (s32 out)::

The current deflection of the spring-wheel (the outer wheel).
Its 0 at rest, and ranges from -7 at the counter-clockwise extreme
It's 0 at rest, and ranges from -7 at the counter-clockwise extreme
to +7 at the clockwise extreme.

'<Prefix>.spring-wheel-f' (float out)::

The current deflection of the spring-wheel (the outer wheel).
Its 0.0 at rest, -1.0 at the counter-clockwise extreme, and +1.0 at
It's 0.0 at rest, -1.0 at the counter-clockwise extreme, and +1.0 at
the clockwise extreme. (The Shuttle devices report the spring-wheel
position as an integer from -7 to +7, so this pin reports only 15
discrete values in its range.)
discrete values in it's range.)
2 changes: 1 addition & 1 deletion docs/src/gcode/g-code.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ G7
Program G7 to enter the diameter mode for axis X on a lathe. When in
the diameter mode the X axis moves on a lathe will be 1/2 the distance
to the center of the lathe. For example X1 would move the cutter to
0.500 from the center of the lathe thus giving a 1 diameter part.
0.500" from the center of the lathe thus giving a 1" diameter part.

[[gcode:g8]]
== G8 Lathe Radius Mode(((G8 Lathe Radius Mode)))
Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/gladevcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2852,7 +2852,7 @@ may be specified using the exported environmental variable:
GLADEVCP_EXTRAS. This variable should be a path list of one or
more configuration directories separated by a (:). Typically,
this variable would be set in a shell starting linuxcnc or in
a users ~/.profile startup script. Example:
a user's ~/.profile startup script. Example:

====
export GLADEVCP_EXTRAS=~/mygladevcp:/opt/othergladevcp
Expand Down
8 changes: 4 additions & 4 deletions docs/src/gui/image-to-gcode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ G-code and as the units for each option labeled '(units)'.

=== Invert Image

If “no”, the black pixel is the lowest point and the white pixel is
the highest point. If yes, the black pixel is the highest point and
If "no", the black pixel is the lowest point and the white pixel is
the highest point. If "yes", the black pixel is the highest point and
the white pixel is the lowest point.

=== Normalize Image
Expand Down Expand Up @@ -144,8 +144,8 @@ The shape of the cutting part of the tool. Possible tool shapes are:

- Ball End
- Flat End
- 45 degree vee
- 60 degree vee
- 45 degree "vee"
- 60 degree "vee"

=== Lace bounding

Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/pyvcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ A table is a container that allows layout in a grid of rows and
columns. Each row is started by a '<tablerow/>' tag. A contained
widget may span rows or columns through the use of
the '<tablespan rows= cols=/>' tag. The sides of the cells to which
the contained widgets stick
the contained widgets "stick"
may be set through the use of the '<tablesticky sticky=/>' tag. A
table expands on its flexible rows and columns.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/gui/tooledit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ TOOL_EDITOR = tooledit Z DIAM
----

.Résultat obtenu
image::images/tooledit-columns_fr.png["Éditeur graphique de table doutils - Choix des colonnes",align="left"]
image::images/tooledit-columns_fr.png["Éditeur graphique de table d'outils - Choix des colonnes",align="left"]

== Stand Alone Use
The 'tooledit' program can also be invoked as a standalone
Expand Down
4 changes: 2 additions & 2 deletions docs/src/hal/canonical-devices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
== Introduction

The following sections show the pins, parameters, and functions that
are supplied by canonical devices. All HAL device drivers should
are supplied by "canonical devices". All HAL device drivers should
supply the same pins and parameters, and implement the same behavior.

Note that the only the `<io-type>` and `<specific-name>` fields are
Expand Down Expand Up @@ -112,7 +112,7 @@ converters or PWM generators.
(funct) *write* -- This causes the calculated value to be output to
the hardware. If enable is false, then the output will be 0,
regardless of *value*, *scale*, and *offset*.
The meaning of “0” is dependent on the hardware. For example, a
The meaning of "0" is dependent on the hardware. For example, a
bipolar 12-bit A/D may need to write 0x1FF (mid scale) to the D/A get 0
volts from the hardware pin. If enable is true, read scale, offset and
value and output to the adc (*scale* * *value*) + *offset*. If enable
Expand Down
20 changes: 10 additions & 10 deletions docs/src/hal/general-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ level tools can be designed to recognize such structure, if the names
provide the necessary information. To do that, all HAL components should
follow these rules:

- Dots (“.”) separate levels of the hierarchy.
This is analogous to the slash (“/”) in a filename.
- Hyphens (“-”) separate words or fields in the same level of the hierarchy.
- HAL components should not use underscores or MixedCase.
- Use only lowercase letters and numbers in names.
- Dots (".") separate levels of the hierarchy.
This is analogous to the slash ("/") in a filename.
- Hyphens ("-") separate words or fields in the same level of the hierarchy.
- HAL components should not use underscores or "MixedCase".
- Use only lowercase letters and numbers in names.

== Hardware Driver Naming Conventions

Expand Down Expand Up @@ -71,20 +71,20 @@ The individual fields are:
Virtually every I/O device has multiple channels, and the channel
number identifies one of them. Like device numbers, channel numbers
start at zero and increment.footnote:[One exception to the
channel numbers start at zero rule is
"channel numbers start at zero" rule is
the parallel port. Its HAL pins are numbered with the corresponding pin
number on the DB-25 connector. This is convenient for wiring, but
inconsistent with other drivers. There is some debate over whether this
is a bug or a feature.]
is a bug or a feature.]
If more than one device is installed, the channel numbers on
additional devices start over at zero. If it is possible to have a
channel number greater than 9, then channel numbers should be two
digits, with a leading zero on numbers less than 10 to preserve sort
ordering. Some modules have pins and/or parameters that affect more
than one channel. For example a PWM generator might have four channels
with four independent duty-cycle inputs, but one frequency
with four independent "duty-cycle" inputs, but one "frequency"
parameter that controls all four channels (due to hardware
limitations). The frequency parameter should use 0-3 as the channel
limitations). The frequency parameter should use "0-3" as the channel
number.

<specific-name>::
Expand All @@ -93,7 +93,7 @@ The individual fields are:
two pins, one is the state of the physical pin, the other is the same
thing inverted. That allows the configurator to choose between active
high and active low inputs. For most io-types, there is a standard set
of pins and parameters, (referred to as the canonical interface) that
of pins and parameters, (referred to as the "canonical interface") that
the driver should implement. The canonical interfaces are described in
the <<cha:canonical-device-interfaces,Canonical Device Interfaces>>
chapter.
Expand Down
6 changes: 3 additions & 3 deletions docs/src/hal/halmodule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ halcmd: show pin

== Userspace components and delays

If you typed show pin quickly, you may see that 'passthrough.out'
If you typed "show pin" quickly, you may see that 'passthrough.out'
still had its old value of 0. This is because of the call to
'time.sleep(1)', which makes the assignment to the output pin occur at
most once per second. Because this is a userspace component, the actual
Expand Down Expand Up @@ -425,10 +425,10 @@ This shows ways to get the pin value and information.
microcontroller to the PC using a serial interface. Python has a very
capable serial interface module called
http://pyserial.sourceforge.net/[pyserial]
(Ubuntu package name python-serial, in the universe repository)
(Ubuntu package name "python-serial", in the universe repository)
* Attach a http://lcdproc.omnipotent.net/[LCDProc]-compatible LCD module
and use it to display a digital readout with information of your choice
(Ubuntu package name lcdproc, in the universe repository)
(Ubuntu package name "lcdproc", in the universe repository)
* Create a virtual control panel using any GUI library supported by
Python (gtk, qt, wxwindows, etc)

Expand Down